Package org.hl7.fhir.dstu3.model

Class Communication

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

All Implemented Interfaces:

ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IAnyResource, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions, org.hl7.fhir.instance.model.api.IBaseResource, org.hl7.fhir.instance.model.api.IDomainResource

public class Communication
extends DomainResource

An occurrence of information being transmitted; e.g. an alert that was sent to a responsible provider, a public health agency was notified about a reportable condition.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Communication.CommunicationPayloadComponent
static enum	Communication.CommunicationStatus
static class	Communication.CommunicationStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field	Description
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	BASED_ON	Fluent Client search parameter constant for based-on
protected List<Reference>	basedOn	An order, proposal or plan fulfilled in whole or in part by this Communication.
protected List<Resource>	basedOnTarget	The actual objects that are the target of the reference (An order, proposal or plan fulfilled in whole or in part by this Communication.)
protected List<CodeableConcept>	category	The type of message conveyed such as alert, notification, reminder, instruction, etc.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	CATEGORY	Fluent Client search parameter constant for category
protected Reference	context	The encounter within which the communication was sent.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	CONTEXT	Fluent Client search parameter constant for context
protected Resource	contextTarget	The actual object that is the target of the reference (The encounter within which the communication was sent.)
protected List<Reference>	definition	A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	DEFINITION	Fluent Client search parameter constant for definition
protected List<Resource>	definitionTarget	The actual objects that are the target of the reference (A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.)
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER	Fluent Client search parameter constant for encounter
protected List<Identifier>	identifier	Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER	Fluent Client search parameter constant for identifier
static final ca.uhn.fhir.model.api.Include	INCLUDE_BASED_ON	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_CONTEXT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_DEFINITION	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PART_OF	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_PATIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_RECIPIENT	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SENDER	Constant for fluent queries to be used to add include statements.
static final ca.uhn.fhir.model.api.Include	INCLUDE_SUBJECT	Constant for fluent queries to be used to add include statements.
protected List<CodeableConcept>	medium	A channel that was used for this communication (e.g.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	MEDIUM	Fluent Client search parameter constant for medium
protected BooleanType	notDone	If true, indicates that the described communication event did not actually occur.
protected CodeableConcept	notDoneReason	Describes why the communication event did not occur in coded and/or textual form.
protected List<Annotation>	note	Additional notes or commentary about the communication by the sender, receiver or other interested parties.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PART_OF	Fluent Client search parameter constant for part-of
protected List<Reference>	partOf	Part of this action.
protected List<Resource>	partOfTarget	The actual objects that are the target of the reference (Part of this action.)
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT	Fluent Client search parameter constant for patient
protected List<Communication.CommunicationPayloadComponent>	payload	Text, attachment(s), or resource(s) that was communicated to the recipient.
protected List<CodeableConcept>	reasonCode	The reason or justification for the communication.
protected List<Reference>	reasonReference	Indicates another resource whose existence justifies this communication.
protected List<Resource>	reasonReferenceTarget	The actual objects that are the target of the reference (Indicates another resource whose existence justifies this communication.)
protected DateTimeType	received	The time when this communication arrived at the destination.
static final ca.uhn.fhir.rest.gclient.DateClientParam	RECEIVED	Fluent Client search parameter constant for received
protected List<Reference>	recipient	The entity (e.g.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	RECIPIENT	Fluent Client search parameter constant for recipient
protected List<Resource>	recipientTarget	The actual objects that are the target of the reference (The entity (e.g.
protected Reference	sender	The entity (e.g.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SENDER	Fluent Client search parameter constant for sender
protected Resource	senderTarget	The actual object that is the target of the reference (The entity (e.g.
protected DateTimeType	sent	The time when this communication was sent.
static final ca.uhn.fhir.rest.gclient.DateClientParam	SENT	Fluent Client search parameter constant for sent
static final String	SP_BASED_ON	Search parameter: based-on
static final String	SP_CATEGORY	Search parameter: category
static final String	SP_CONTEXT	Search parameter: context
static final String	SP_DEFINITION	Search parameter: definition
static final String	SP_ENCOUNTER	Search parameter: encounter
static final String	SP_IDENTIFIER	Search parameter: identifier
static final String	SP_MEDIUM	Search parameter: medium
static final String	SP_PART_OF	Search parameter: part-of
static final String	SP_PATIENT	Search parameter: patient
static final String	SP_RECEIVED	Search parameter: received
static final String	SP_RECIPIENT	Search parameter: recipient
static final String	SP_SENDER	Search parameter: sender
static final String	SP_SENT	Search parameter: sent
static final String	SP_STATUS	Search parameter: status
static final String	SP_SUBJECT	Search parameter: subject
protected Enumeration<Communication.CommunicationStatus>	status	The status of the transmission.
static final ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS	Fluent Client search parameter constant for status
protected Reference	subject	The patient or group that was the focus of this communication.
static final ca.uhn.fhir.rest.gclient.ReferenceClientParam	SUBJECT	Fluent Client search parameter constant for subject
protected Resource	subjectTarget	The actual object that is the target of the reference (The patient or group that was the focus of this communication.)
protected List<Reference>	topic	The resources which were responsible for or related to producing this communication.
protected List<Resource>	topicTarget	The actual objects that are the target of the reference (The resources which were responsible for or related to producing this communication.)

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, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG

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

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor	Description
Communication()	Constructor
Communication(Enumeration<Communication.CommunicationStatus> status)	Constructor

Method Summary

Modifier and Type	Method	Description
Reference	addBasedOn()
Communication	addBasedOn(Reference t)
CodeableConcept	addCategory()
Communication	addCategory(CodeableConcept t)
Base	addChild(String name)
Reference	addDefinition()
Communication	addDefinition(Reference t)
Identifier	addIdentifier()
Communication	addIdentifier(Identifier t)
CodeableConcept	addMedium()
Communication	addMedium(CodeableConcept t)
Annotation	addNote()
Communication	addNote(Annotation t)
Reference	addPartOf()
Communication	addPartOf(Reference t)
Communication.CommunicationPayloadComponent	addPayload()
Communication	addPayload(Communication.CommunicationPayloadComponent t)
CodeableConcept	addReasonCode()
Communication	addReasonCode(CodeableConcept t)
Reference	addReasonReference()
Communication	addReasonReference(Reference t)
Reference	addRecipient()
Communication	addRecipient(Reference t)
Reference	addTopic()
Communication	addTopic(Reference t)
Communication	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
List<Reference>	getBasedOn()
Reference	getBasedOnFirstRep()
List<Resource>	getBasedOnTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<CodeableConcept>	getCategory()
CodeableConcept	getCategoryFirstRep()
Reference	getContext()
Resource	getContextTarget()
List<Reference>	getDefinition()
Reference	getDefinitionFirstRep()
List<Resource>	getDefinitionTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
List<CodeableConcept>	getMedium()
CodeableConcept	getMediumFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
boolean	getNotDone()
BooleanType	getNotDoneElement()
CodeableConcept	getNotDoneReason()
List<Annotation>	getNote()
Annotation	getNoteFirstRep()
List<Reference>	getPartOf()
Reference	getPartOfFirstRep()
List<Resource>	getPartOfTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
List<Communication.CommunicationPayloadComponent>	getPayload()
Communication.CommunicationPayloadComponent	getPayloadFirstRep()
Base[]	getProperty(int hash, String name, boolean checkValid)
List<CodeableConcept>	getReasonCode()
CodeableConcept	getReasonCodeFirstRep()
List<Reference>	getReasonReference()
Reference	getReasonReferenceFirstRep()
List<Resource>	getReasonReferenceTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
Date	getReceived()
DateTimeType	getReceivedElement()
List<Reference>	getRecipient()
Reference	getRecipientFirstRep()
List<Resource>	getRecipientTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
ResourceType	getResourceType()
Reference	getSender()
Resource	getSenderTarget()
Date	getSent()
DateTimeType	getSentElement()
Communication.CommunicationStatus	getStatus()
Enumeration<Communication.CommunicationStatus>	getStatusElement()
Reference	getSubject()
Resource	getSubjectTarget()
List<Reference>	getTopic()
Reference	getTopicFirstRep()
List<Resource>	getTopicTarget()	Deprecated. Use Reference#setResource(IBaseResource) instead
String[]	getTypesForProperty(int hash, String name)
boolean	hasBasedOn()
boolean	hasCategory()
boolean	hasContext()
boolean	hasDefinition()
boolean	hasIdentifier()
boolean	hasMedium()
boolean	hasNotDone()
boolean	hasNotDoneElement()
boolean	hasNotDoneReason()
boolean	hasNote()
boolean	hasPartOf()
boolean	hasPayload()
boolean	hasReasonCode()
boolean	hasReasonReference()
boolean	hasReceived()
boolean	hasReceivedElement()
boolean	hasRecipient()
boolean	hasSender()
boolean	hasSent()
boolean	hasSentElement()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	hasSubject()
boolean	hasTopic()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
Communication	setBasedOn(List<Reference> theBasedOn)
Communication	setCategory(List<CodeableConcept> theCategory)
Communication	setContext(Reference value)
Communication	setContextTarget(Resource value)
Communication	setDefinition(List<Reference> theDefinition)
Communication	setIdentifier(List<Identifier> theIdentifier)
Communication	setMedium(List<CodeableConcept> theMedium)
Communication	setNotDone(boolean value)
Communication	setNotDoneElement(BooleanType value)
Communication	setNotDoneReason(CodeableConcept value)
Communication	setNote(List<Annotation> theNote)
Communication	setPartOf(List<Reference> thePartOf)
Communication	setPayload(List<Communication.CommunicationPayloadComponent> thePayload)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
Communication	setReasonCode(List<CodeableConcept> theReasonCode)
Communication	setReasonReference(List<Reference> theReasonReference)
Communication	setReceived(Date value)
Communication	setReceivedElement(DateTimeType value)
Communication	setRecipient(List<Reference> theRecipient)
Communication	setSender(Reference value)
Communication	setSenderTarget(Resource value)
Communication	setSent(Date value)
Communication	setSentElement(DateTimeType value)
Communication	setStatus(Communication.CommunicationStatus value)
Communication	setStatusElement(Enumeration<Communication.CommunicationStatus> value)
Communication	setSubject(Reference value)
Communication	setSubjectTarget(Resource value)
Communication	setTopic(List<Reference> theTopic)
protected Communication	typedCopy()

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

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

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

copyValues, getId, getIdBase, getIdElement, getIdPart, 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, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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.IBase

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

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

getMeta, getStructureFhirVersionEnum, isDeleted, setId

Field Details

identifier

protected List<Identifier> identifier

Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

definition

protected List<Reference> definition

A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.

definitionTarget

protected List<Resource> definitionTarget

The actual objects that are the target of the reference (A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.)

basedOn

protected List<Reference> basedOn

An order, proposal or plan fulfilled in whole or in part by this Communication.

basedOnTarget

protected List<Resource> basedOnTarget

The actual objects that are the target of the reference (An order, proposal or plan fulfilled in whole or in part by this Communication.)

partOf

protected List<Reference> partOf

Part of this action.

partOfTarget

protected List<Resource> partOfTarget

The actual objects that are the target of the reference (Part of this action.)

status

protected Enumeration<Communication.CommunicationStatus> status

The status of the transmission.

notDone

protected BooleanType notDone

If true, indicates that the described communication event did not actually occur.

notDoneReason

protected CodeableConcept notDoneReason

Describes why the communication event did not occur in coded and/or textual form.

category

protected List<CodeableConcept> category

The type of message conveyed such as alert, notification, reminder, instruction, etc.

medium

protected List<CodeableConcept> medium

A channel that was used for this communication (e.g. email, fax).

subject

protected Reference subject

The patient or group that was the focus of this communication.

subjectTarget

protected Resource subjectTarget

The actual object that is the target of the reference (The patient or group that was the focus of this communication.)

recipient

protected List<Reference> recipient

The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).

recipientTarget

protected List<Resource> recipientTarget

The actual objects that are the target of the reference (The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).)

topic

protected List<Reference> topic

The resources which were responsible for or related to producing this communication.

topicTarget

protected List<Resource> topicTarget

The actual objects that are the target of the reference (The resources which were responsible for or related to producing this communication.)

context

protected Reference context

The encounter within which the communication was sent.

contextTarget

protected Resource contextTarget

The actual object that is the target of the reference (The encounter within which the communication was sent.)

sent

protected DateTimeType sent

The time when this communication was sent.

received

protected DateTimeType received

The time when this communication arrived at the destination.

sender

protected Reference sender

The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.

senderTarget

protected Resource senderTarget

The actual object that is the target of the reference (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)

reasonCode

protected List<CodeableConcept> reasonCode

The reason or justification for the communication.

reasonReference

protected List<Reference> reasonReference

Indicates another resource whose existence justifies this communication.

reasonReferenceTarget

protected List<Resource> reasonReferenceTarget

The actual objects that are the target of the reference (Indicates another resource whose existence justifies this communication.)

payload

protected List<Communication.CommunicationPayloadComponent> payload

Text, attachment(s), or resource(s) that was communicated to the recipient.

note

protected List<Annotation> note

Additional notes or commentary about the communication by the sender, receiver or other interested parties.

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

Description: Unique identifier
Type: token
Path: Communication.identifier

See Also:

• Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Unique identifier
Type: token
Path: Communication.identifier

SP_SUBJECT

public static final String SP_SUBJECT

Search parameter: subject

Description: Focus of message
Type: reference
Path: Communication.subject

See Also:

• Constant Field Values

SUBJECT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT

Fluent Client search parameter constant for subject

Description: Focus of message
Type: reference
Path: Communication.subject

INCLUDE_SUBJECT

public static final ca.uhn.fhir.model.api.Include INCLUDE_SUBJECT

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

SP_RECEIVED

public static final String SP_RECEIVED

Search parameter: received

Description: When received
Type: date
Path: Communication.received

See Also:

• Constant Field Values

RECEIVED

public static final ca.uhn.fhir.rest.gclient.DateClientParam RECEIVED

Fluent Client search parameter constant for received

Description: When received
Type: date
Path: Communication.received

SP_PART_OF

public static final String SP_PART_OF

Search parameter: part-of

Description: Part of this action
Type: reference
Path: Communication.partOf

See Also:

• Constant Field Values

PART_OF

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF

Fluent Client search parameter constant for part-of

Description: Part of this action
Type: reference
Path: Communication.partOf

INCLUDE_PART_OF

public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF

Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:part-of".

SP_MEDIUM

public static final String SP_MEDIUM

Search parameter: medium

Description: A channel of communication
Type: token
Path: Communication.medium

See Also:

• Constant Field Values

MEDIUM

public static final ca.uhn.fhir.rest.gclient.TokenClientParam MEDIUM

Fluent Client search parameter constant for medium

Description: A channel of communication
Type: token
Path: Communication.medium

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter: encounter

Description: Encounter leading to message
Type: reference
Path: Communication.context

See Also:

• Constant Field Values

ENCOUNTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description: Encounter leading to message
Type: reference
Path: Communication.context

INCLUDE_ENCOUNTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER

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

SP_SENT

public static final String SP_SENT

Search parameter: sent

Description: When sent
Type: date
Path: Communication.sent

See Also:

• Constant Field Values

SENT

public static final ca.uhn.fhir.rest.gclient.DateClientParam SENT

Fluent Client search parameter constant for sent

Description: When sent
Type: date
Path: Communication.sent

SP_BASED_ON

public static final String SP_BASED_ON

Search parameter: based-on

Description: Request fulfilled by this communication
Type: reference
Path: Communication.basedOn

See Also:

• Constant Field Values

BASED_ON

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON

Fluent Client search parameter constant for based-on

Description: Request fulfilled by this communication
Type: reference
Path: Communication.basedOn

INCLUDE_BASED_ON

public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON

Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:based-on".

SP_SENDER

public static final String SP_SENDER

Search parameter: sender

Description: Message sender
Type: reference
Path: Communication.sender

See Also:

• Constant Field Values

SENDER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SENDER

Fluent Client search parameter constant for sender

Description: Message sender
Type: reference
Path: Communication.sender

INCLUDE_SENDER

public static final ca.uhn.fhir.model.api.Include INCLUDE_SENDER

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

SP_PATIENT

public static final String SP_PATIENT

Search parameter: patient

Description: Focus of message
Type: reference
Path: Communication.subject

See Also:

• Constant Field Values

PATIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: Focus of message
Type: reference
Path: Communication.subject

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

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

SP_RECIPIENT

public static final String SP_RECIPIENT

Search parameter: recipient

Description: Message recipient
Type: reference
Path: Communication.recipient

See Also:

• Constant Field Values

RECIPIENT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECIPIENT

Fluent Client search parameter constant for recipient

Description: Message recipient
Type: reference
Path: Communication.recipient

INCLUDE_RECIPIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_RECIPIENT

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

SP_CONTEXT

public static final String SP_CONTEXT

Search parameter: context

Description: Encounter or episode leading to message
Type: reference
Path: Communication.context

See Also:

• Constant Field Values

CONTEXT

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT

Fluent Client search parameter constant for context

Description: Encounter or episode leading to message
Type: reference
Path: Communication.context

INCLUDE_CONTEXT

public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT

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

SP_DEFINITION

public static final String SP_DEFINITION

Search parameter: definition

Description: Instantiates protocol or definition
Type: reference
Path: Communication.definition

See Also:

• Constant Field Values

DEFINITION

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEFINITION

Fluent Client search parameter constant for definition

Description: Instantiates protocol or definition
Type: reference
Path: Communication.definition

INCLUDE_DEFINITION

public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION

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

SP_CATEGORY

public static final String SP_CATEGORY

Search parameter: category

Description: Message category
Type: token
Path: Communication.category

See Also:

• Constant Field Values

CATEGORY

public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY

Fluent Client search parameter constant for category

Description: Message category
Type: token
Path: Communication.category

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: preparation | in-progress | suspended | aborted | completed | entered-in-error
Type: token
Path: Communication.status

See Also:

• Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: preparation | in-progress | suspended | aborted | completed | entered-in-error
Type: token
Path: Communication.status

Constructor Details

Communication

public Communication()

Constructor

Communication

public Communication(Enumeration<Communication.CommunicationStatus> status)

Constructor

Method Details

getIdentifier

public List<Identifier> getIdentifier()

Returns:

identifier (Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)

setIdentifier

public Communication setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public Communication addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

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

getDefinition

public List<Reference> getDefinition()

Returns:

definition (A protocol, guideline, or other definition that was adhered to in whole or in part by this communication event.)

setDefinition

public Communication setDefinition(List<Reference> theDefinition)

Returns:

Returns a reference to this for easy method chaining

hasDefinition

public boolean hasDefinition()

addDefinition

public Reference addDefinition()

addDefinition

public Communication addDefinition(Reference t)

getDefinitionFirstRep

public Reference getDefinitionFirstRep()

Returns:

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

getDefinitionTarget

@Deprecated
public List<Resource> getDefinitionTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getBasedOn

public List<Reference> getBasedOn()

Returns:

basedOn (An order, proposal or plan fulfilled in whole or in part by this Communication.)

setBasedOn

public Communication setBasedOn(List<Reference> theBasedOn)

Returns:

Returns a reference to this for easy method chaining

hasBasedOn

public boolean hasBasedOn()

addBasedOn

public Reference addBasedOn()

addBasedOn

public Communication addBasedOn(Reference t)

getBasedOnFirstRep

public Reference getBasedOnFirstRep()

Returns:

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

getBasedOnTarget

@Deprecated
public List<Resource> getBasedOnTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getPartOf

public List<Reference> getPartOf()

Returns:

partOf (Part of this action.)

setPartOf

public Communication setPartOf(List<Reference> thePartOf)

Returns:

Returns a reference to this for easy method chaining

hasPartOf

public boolean hasPartOf()

addPartOf

public Reference addPartOf()

addPartOf

public Communication addPartOf(Reference t)

getPartOfFirstRep

public Reference getPartOfFirstRep()

Returns:

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

getPartOfTarget

@Deprecated
public List<Resource> getPartOfTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getStatusElement

public Enumeration<Communication.CommunicationStatus> getStatusElement()

Returns:

status (The status of the transmission.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public Communication setStatusElement(Enumeration<Communication.CommunicationStatus> value)

Parameters:

value - status (The status of the transmission.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public Communication.CommunicationStatus getStatus()

Returns:

The status of the transmission.

setStatus

public Communication setStatus(Communication.CommunicationStatus value)

Parameters:

value - The status of the transmission.

getNotDoneElement

public BooleanType getNotDoneElement()

Returns:

notDone (If true, indicates that the described communication event did not actually occur.). This is the underlying object with id, value and extensions. The accessor "getNotDone" gives direct access to the value

hasNotDoneElement

public boolean hasNotDoneElement()

hasNotDone

public boolean hasNotDone()

setNotDoneElement

public Communication setNotDoneElement(BooleanType value)

Parameters:

value - notDone (If true, indicates that the described communication event did not actually occur.). This is the underlying object with id, value and extensions. The accessor "getNotDone" gives direct access to the value

getNotDone

public boolean getNotDone()

Returns:

If true, indicates that the described communication event did not actually occur.

setNotDone

public Communication setNotDone(boolean value)

Parameters:

value - If true, indicates that the described communication event did not actually occur.

getNotDoneReason

public CodeableConcept getNotDoneReason()

Returns:

notDoneReason (Describes why the communication event did not occur in coded and/or textual form.)

hasNotDoneReason

public boolean hasNotDoneReason()

setNotDoneReason

public Communication setNotDoneReason(CodeableConcept value)

Parameters:

value - notDoneReason (Describes why the communication event did not occur in coded and/or textual form.)

getCategory

public List<CodeableConcept> getCategory()

Returns:

category (The type of message conveyed such as alert, notification, reminder, instruction, etc.)

setCategory

public Communication setCategory(List<CodeableConcept> theCategory)

Returns:

Returns a reference to this for easy method chaining

hasCategory

public boolean hasCategory()

addCategory

public CodeableConcept addCategory()

addCategory

public Communication addCategory(CodeableConcept t)

getCategoryFirstRep

public CodeableConcept getCategoryFirstRep()

Returns:

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

getMedium

public List<CodeableConcept> getMedium()

Returns:

medium (A channel that was used for this communication (e.g. email, fax).)

setMedium

public Communication setMedium(List<CodeableConcept> theMedium)

Returns:

Returns a reference to this for easy method chaining

hasMedium

public boolean hasMedium()

addMedium

public CodeableConcept addMedium()

addMedium

public Communication addMedium(CodeableConcept t)

getMediumFirstRep

public CodeableConcept getMediumFirstRep()

Returns:

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

getSubject

public Reference getSubject()

Returns:

subject (The patient or group that was the focus of this communication.)

hasSubject

public boolean hasSubject()

setSubject

public Communication setSubject(Reference value)

Parameters:

value - subject (The patient or group that was the focus of this communication.)

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. (The patient or group that was the focus of this communication.)

setSubjectTarget

public Communication 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. (The patient or group that was the focus of this communication.)

getRecipient

public List<Reference> getRecipient()

Returns:

recipient (The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).)

setRecipient

public Communication setRecipient(List<Reference> theRecipient)

Returns:

Returns a reference to this for easy method chaining

hasRecipient

public boolean hasRecipient()

addRecipient

public Reference addRecipient()

addRecipient

public Communication addRecipient(Reference t)

getRecipientFirstRep

public Reference getRecipientFirstRep()

Returns:

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

getRecipientTarget

@Deprecated
public List<Resource> getRecipientTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getTopic

public List<Reference> getTopic()

Returns:

topic (The resources which were responsible for or related to producing this communication.)

setTopic

public Communication setTopic(List<Reference> theTopic)

Returns:

Returns a reference to this for easy method chaining

hasTopic

public boolean hasTopic()

addTopic

public Reference addTopic()

addTopic

public Communication addTopic(Reference t)

getTopicFirstRep

public Reference getTopicFirstRep()

Returns:

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

getTopicTarget

@Deprecated
public List<Resource> getTopicTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getContext

public Reference getContext()

Returns:

context (The encounter within which the communication was sent.)

hasContext

public boolean hasContext()

setContext

public Communication setContext(Reference value)

Parameters:

value - context (The encounter within which the communication was sent.)

getContextTarget

public Resource getContextTarget()

Returns:

context 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. (The encounter within which the communication was sent.)

setContextTarget

public Communication setContextTarget(Resource value)

Parameters:

value - context 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. (The encounter within which the communication was sent.)

getSentElement

public DateTimeType getSentElement()

Returns:

sent (The time when this communication was sent.). This is the underlying object with id, value and extensions. The accessor "getSent" gives direct access to the value

hasSentElement

public boolean hasSentElement()

hasSent

public boolean hasSent()

setSentElement

public Communication setSentElement(DateTimeType value)

Parameters:

value - sent (The time when this communication was sent.). This is the underlying object with id, value and extensions. The accessor "getSent" gives direct access to the value

getSent

public Date getSent()

Returns:

The time when this communication was sent.

setSent

public Communication setSent(Date value)

Parameters:

value - The time when this communication was sent.

getReceivedElement

public DateTimeType getReceivedElement()

Returns:

received (The time when this communication arrived at the destination.). This is the underlying object with id, value and extensions. The accessor "getReceived" gives direct access to the value

hasReceivedElement

public boolean hasReceivedElement()

hasReceived

public boolean hasReceived()

setReceivedElement

public Communication setReceivedElement(DateTimeType value)

Parameters:

value - received (The time when this communication arrived at the destination.). This is the underlying object with id, value and extensions. The accessor "getReceived" gives direct access to the value

getReceived

public Date getReceived()

Returns:

The time when this communication arrived at the destination.

setReceived

public Communication setReceived(Date value)

Parameters:

value - The time when this communication arrived at the destination.

getSender

public Reference getSender()

Returns:

sender (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)

hasSender

public boolean hasSender()

setSender

public Communication setSender(Reference value)

Parameters:

value - sender (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)

getSenderTarget

public Resource getSenderTarget()

Returns:

sender 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. (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)

setSenderTarget

public Communication setSenderTarget(Resource value)

Parameters:

value - sender 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. (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)

getReasonCode

public List<CodeableConcept> getReasonCode()

Returns:

reasonCode (The reason or justification for the communication.)

setReasonCode

public Communication setReasonCode(List<CodeableConcept> theReasonCode)

Returns:

Returns a reference to this for easy method chaining

hasReasonCode

public boolean hasReasonCode()

addReasonCode

public CodeableConcept addReasonCode()

addReasonCode

public Communication addReasonCode(CodeableConcept t)

getReasonCodeFirstRep

public CodeableConcept getReasonCodeFirstRep()

Returns:

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

getReasonReference

public List<Reference> getReasonReference()

Returns:

reasonReference (Indicates another resource whose existence justifies this communication.)

setReasonReference

public Communication setReasonReference(List<Reference> theReasonReference)

Returns:

Returns a reference to this for easy method chaining

hasReasonReference

public boolean hasReasonReference()

addReasonReference

public Reference addReasonReference()

addReasonReference

public Communication addReasonReference(Reference t)

getReasonReferenceFirstRep

public Reference getReasonReferenceFirstRep()

Returns:

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

getReasonReferenceTarget

@Deprecated
public List<Resource> getReasonReferenceTarget()

Deprecated.

Use Reference#setResource(IBaseResource) instead

getPayload

public List<Communication.CommunicationPayloadComponent> getPayload()

Returns:

payload (Text, attachment(s), or resource(s) that was communicated to the recipient.)

setPayload

public Communication setPayload(List<Communication.CommunicationPayloadComponent> thePayload)

Returns:

Returns a reference to this for easy method chaining

hasPayload

public boolean hasPayload()

addPayload

public Communication.CommunicationPayloadComponent addPayload()

addPayload

public Communication addPayload(Communication.CommunicationPayloadComponent t)

getPayloadFirstRep

public Communication.CommunicationPayloadComponent getPayloadFirstRep()

Returns:

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

getNote

public List<Annotation> getNote()

Returns:

note (Additional notes or commentary about the communication by the sender, receiver or other interested parties.)

setNote

public Communication setNote(List<Annotation> theNote)

Returns:

Returns a reference to this for easy method chaining

hasNote

public boolean hasNote()

addNote

public Annotation addNote()

addNote

public Communication addNote(Annotation t)

getNoteFirstRep

public Annotation getNoteFirstRep()

Returns:

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

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

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

Overrides:

getNamedProperty in class DomainResource

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 DomainResource

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 DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

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

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

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

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

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

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

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

Overrides:

addChild in class DomainResource

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 DomainResource

copy

public Communication copy()

Specified by:

copy in class DomainResource

typedCopy

protected Communication 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 org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource