Class 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
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionOther resources that pertain to this communication and to which this communication should be associated.The actual objects that are the target of the reference (Other resources that pertain to this communication and to which this communication should be associated.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for based-onAn order, proposal or plan fulfilled in whole or in part by this Communication.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> The type of message conveyed such as alert, notification, reminder, instruction, etc.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryprotected Reference
The Encounter during which this Communication was created or to which the creation of this record is tightly associated.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterprotected Encounter
The actual object that is the target of the reference (The Encounter during which this Communication was created or to which the creation of this record is tightly associated.)protected List
<Identifier> Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.Prior communication that this communication is in response to.protected List
<Communication> The actual objects that are the target of the reference (Prior communication that this communication is in response to.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for instantiates-canonicalstatic final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for instantiates-uriprotected List
<CanonicalType> The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.protected List
<CodeableConcept> A channel that was used for this communication (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for mediumprotected List
<Annotation> Additional notes or commentary about the communication by the sender, receiver or other interested parties.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for part-ofPart of this action.The actual objects that are the target of the reference (Part of this action.)static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected List
<Communication.CommunicationPayloadComponent> Text, attachment(s), or resource(s) that was communicated to the recipient.protected Enumeration
<Communication.CommunicationPriority> Characterizes how quickly the planned or in progress communication must be addressed.protected List
<CodeableConcept> The reason or justification for the communication.Indicates another resource whose existence justifies this communication.The actual objects that are the target of the reference (Indicates another resource whose existence justifies this communication.)protected DateTimeType
The time when this communication arrived at the destination.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for receivedThe entity (e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for recipientThe actual objects that are the target of the reference (The entity (e.g.protected Reference
The entity (e.g.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for senderprotected Resource
The actual object that is the target of the reference (The entity (e.g.protected DateTimeType
The time when this communication was sent.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for sentstatic final String
Search parameter: based-onstatic final String
Search parameter: categorystatic final String
Search parameter: encounterstatic final String
Search parameter: identifierstatic final String
Search parameter: instantiates-canonicalstatic final String
Search parameter: instantiates-uristatic final String
Search parameter: mediumstatic final String
Search parameter: part-ofstatic final String
Search parameter: patientstatic final String
Search parameter: receivedstatic final String
Search parameter: recipientstatic final String
Search parameter: senderstatic final String
Search parameter: sentstatic final String
Search parameter: statusstatic final String
Search parameter: subjectprotected Enumeration
<Communication.CommunicationStatus> The status of the transmission.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected CodeableConcept
Captures the reason for the current state of the Communication.protected Reference
The patient or group that was the focus of this communication.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (The patient or group that was the focus of this communication.)protected CodeableConcept
Description of the purpose/content, similar to a subject line in an email.Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.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
ConstructorDescriptionConstructorConstructor -
Method Summary
Modifier and TypeMethodDescriptionaddAbout()
Deprecated.Use Reference#setResource(IBaseResource) insteadaddInstantiatesCanonical
(String value) addInstantiatesUri
(String value) addNote()
copy()
void
copyValues
(Communication dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getAbout()
Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Deprecated.Use Reference#setResource(IBaseResource) insteadBase[]
getProperty
(int hash, String name, boolean checkValid) Deprecated.Use Reference#setResource(IBaseResource) insteadDeprecated.Use Reference#setResource(IBaseResource) insteadgetSent()
getTopic()
String[]
getTypesForProperty
(int hash, String name) boolean
hasAbout()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasInstantiatesCanonical
(String value) boolean
boolean
hasInstantiatesUri
(String value) boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasSent()
boolean
boolean
boolean
boolean
boolean
boolean
hasTopic()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setBasedOn
(List<Reference> theBasedOn) setCategory
(List<CodeableConcept> theCategory) setEncounter
(Reference value) setEncounterTarget
(Encounter value) setIdentifier
(List<Identifier> theIdentifier) setInResponseTo
(List<Reference> theInResponseTo) setInstantiatesCanonical
(List<CanonicalType> theInstantiatesCanonical) setInstantiatesUri
(List<UriType> theInstantiatesUri) setMedium
(List<CodeableConcept> theMedium) setNote
(List<Annotation> theNote) setPayload
(List<Communication.CommunicationPayloadComponent> thePayload) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReasonCode
(List<CodeableConcept> theReasonCode) setReasonReference
(List<Reference> theReasonReference) setReceived
(Date value) setReceivedElement
(DateTimeType value) setRecipient
(List<Reference> theRecipient) setSenderTarget
(Resource value) setSentElement
(DateTimeType value) setStatusReason
(CodeableConcept value) setSubject
(Reference value) setSubjectTarget
(Resource value) setTopic
(CodeableConcept value) protected Communication
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
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, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server. -
instantiatesCanonical
The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. -
instantiatesUri
The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication. -
basedOn
An order, proposal or plan fulfilled in whole or in part by this Communication. -
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
Part of this action. -
partOfTarget
The actual objects that are the target of the reference (Part of this action.) -
inResponseTo
Prior communication that this communication is in response to. -
inResponseToTarget
The actual objects that are the target of the reference (Prior communication that this communication is in response to.) -
status
The status of the transmission. -
statusReason
Captures the reason for the current state of the Communication. -
category
The type of message conveyed such as alert, notification, reminder, instruction, etc. -
priority
Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine. -
medium
A channel that was used for this communication (e.g. email, fax). -
subject
The patient or group that was the focus of this communication. -
subjectTarget
The actual object that is the target of the reference (The patient or group that was the focus of this communication.) -
topic
Description of the purpose/content, similar to a subject line in an email. -
about
Other resources that pertain to this communication and to which this communication should be associated. -
aboutTarget
The actual objects that are the target of the reference (Other resources that pertain to this communication and to which this communication should be associated.) -
encounter
The Encounter during which this Communication was created or to which the creation of this record is tightly associated. -
encounterTarget
The actual object that is the target of the reference (The Encounter during which this Communication was created or to which the creation of this record is tightly associated.) -
sent
The time when this communication was sent. -
received
The time when this communication arrived at the destination. -
recipient
The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time). -
recipientTarget
The actual objects that are the target of the reference (The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).) -
sender
The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication. -
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
The reason or justification for the communication. -
reasonReference
Indicates another resource whose existence justifies this communication. -
reasonReferenceTarget
The actual objects that are the target of the reference (Indicates another resource whose existence justifies this communication.) -
payload
Text, attachment(s), or resource(s) that was communicated to the recipient. -
note
Additional notes or commentary about the communication by the sender, receiver or other interested parties. -
SP_IDENTIFIER
Search parameter: identifierDescription: Unique identifier
Type: token
Path: Communication.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Unique identifier
Type: token
Path: Communication.identifier
-
SP_SUBJECT
Search parameter: subjectDescription: Focus of message
Type: reference
Path: Communication.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Focus of message
Type: reference
Path: Communication.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:subject". -
SP_INSTANTIATES_CANONICAL
Search parameter: instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: Communication.instantiatesCanonical
- See Also:
-
INSTANTIATES_CANONICAL
Fluent Client search parameter constant for instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: Communication.instantiatesCanonical
-
INCLUDE_INSTANTIATES_CANONICAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:instantiates-canonical". -
SP_RECEIVED
Search parameter: receivedDescription: When received
Type: date
Path: Communication.received
- See Also:
-
RECEIVED
Fluent Client search parameter constant for receivedDescription: When received
Type: date
Path: Communication.received
-
SP_PART_OF
Search parameter: part-ofDescription: Part of this action
Type: reference
Path: Communication.partOf
- See Also:
-
PART_OF
Fluent Client search parameter constant for part-ofDescription: Part of this action
Type: reference
Path: Communication.partOf
-
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:part-of". -
SP_MEDIUM
Search parameter: mediumDescription: A channel of communication
Type: token
Path: Communication.medium
- See Also:
-
MEDIUM
Fluent Client search parameter constant for mediumDescription: A channel of communication
Type: token
Path: Communication.medium
-
SP_ENCOUNTER
Search parameter: encounterDescription: Encounter created as part of
Type: reference
Path: Communication.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Encounter created as part of
Type: reference
Path: Communication.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:encounter". -
SP_SENT
Search parameter: sentDescription: When sent
Type: date
Path: Communication.sent
- See Also:
-
SENT
Fluent Client search parameter constant for sentDescription: When sent
Type: date
Path: Communication.sent
-
SP_BASED_ON
Search parameter: based-onDescription: Request fulfilled by this communication
Type: reference
Path: Communication.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: Request fulfilled by this communication
Type: reference
Path: Communication.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:based-on". -
SP_SENDER
Search parameter: senderDescription: Message sender
Type: reference
Path: Communication.sender
- See Also:
-
SENDER
Fluent Client search parameter constant for senderDescription: Message sender
Type: reference
Path: Communication.sender
-
INCLUDE_SENDER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:sender". -
SP_PATIENT
Search parameter: patientDescription: Focus of message
Type: reference
Path: Communication.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Focus of message
Type: reference
Path: Communication.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:patient". -
SP_RECIPIENT
Search parameter: recipientDescription: Message recipient
Type: reference
Path: Communication.recipient
- See Also:
-
RECIPIENT
Fluent Client search parameter constant for recipientDescription: Message recipient
Type: reference
Path: Communication.recipient
-
INCLUDE_RECIPIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:recipient". -
SP_INSTANTIATES_URI
Search parameter: instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: Communication.instantiatesUri
- See Also:
-
INSTANTIATES_URI
Fluent Client search parameter constant for instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: Communication.instantiatesUri
-
SP_CATEGORY
Search parameter: categoryDescription: Message category
Type: token
Path: Communication.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Message category
Type: token
Path: Communication.category
-
SP_STATUS
Search parameter: statusDescription: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Type: token
Path: Communication.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Type: token
Path: Communication.status
-
-
Constructor Details
-
Communication
public Communication()Constructor -
Communication
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifiers assigned to this communication by the performer or other systems which remain constant as the resource is updated and propagates from server to server.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getInstantiatesCanonical
- Returns:
instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.)
-
setInstantiatesCanonical
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesCanonical
-
addInstantiatesCanonicalElement
- Returns:
instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.)
-
addInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.)
-
hasInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.)
-
getInstantiatesUri
- Returns:
instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.)
-
setInstantiatesUri
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesUri
-
addInstantiatesUriElement
- Returns:
instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.)
-
addInstantiatesUri
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.)
-
hasInstantiatesUri
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this Communication.)
-
getBasedOn
- Returns:
basedOn
(An order, proposal or plan fulfilled in whole or in part by this Communication.)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist
-
getBasedOnTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getPartOf
- Returns:
partOf
(Part of this action.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist
-
getPartOfTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getInResponseTo
- Returns:
inResponseTo
(Prior communication that this communication is in response to.)
-
setInResponseTo
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInResponseTo
-
addInResponseTo
-
addInResponseTo
-
getInResponseToFirstRep
- Returns:
- The first repetition of repeating field
inResponseTo
, creating it if it does not already exist
-
getInResponseToTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
addInResponseToTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
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
-
hasStatus
-
setStatusElement
- 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
- Returns:
- The status of the transmission.
-
setStatus
- Parameters:
value
- The status of the transmission.
-
getStatusReason
- Returns:
statusReason
(Captures the reason for the current state of the Communication.)
-
hasStatusReason
-
setStatusReason
- Parameters:
value
-statusReason
(Captures the reason for the current state of the Communication.)
-
getCategory
- Returns:
category
(The type of message conveyed such as alert, notification, reminder, instruction, etc.)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist
-
getPriorityElement
- Returns:
priority
(Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
hasPriorityElement
-
hasPriority
-
setPriorityElement
- Parameters:
value
-priority
(Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.). This is the underlying object with id, value and extensions. The accessor "getPriority" gives direct access to the value
-
getPriority
- Returns:
- Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
-
setPriority
- Parameters:
value
- Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
-
getMedium
- Returns:
medium
(A channel that was used for this communication (e.g. email, fax).)
-
setMedium
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasMedium
-
addMedium
-
addMedium
-
getMediumFirstRep
- Returns:
- The first repetition of repeating field
medium
, creating it if it does not already exist
-
getSubject
- Returns:
subject
(The patient or group that was the focus of this communication.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The patient or group that was the focus of this communication.)
-
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
- 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.)
-
getTopic
- Returns:
topic
(Description of the purpose/content, similar to a subject line in an email.)
-
hasTopic
-
setTopic
- Parameters:
value
-topic
(Description of the purpose/content, similar to a subject line in an email.)
-
getAbout
- Returns:
about
(Other resources that pertain to this communication and to which this communication should be associated.)
-
setAbout
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAbout
-
addAbout
-
addAbout
-
getAboutFirstRep
- Returns:
- The first repetition of repeating field
about
, creating it if it does not already exist
-
getAboutTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getEncounter
- Returns:
encounter
(The Encounter during which this Communication was created or to which the creation of this record is tightly associated.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The Encounter during which this Communication was created or to which the creation of this record is tightly associated.)
-
getEncounterTarget
- Returns:
encounter
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 during which this Communication was created or to which the creation of this record is tightly associated.)
-
setEncounterTarget
- Parameters:
value
-encounter
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 during which this Communication was created or to which the creation of this record is tightly associated.)
-
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
-
hasSent
-
setSentElement
- 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
- Returns:
- The time when this communication was sent.
-
setSent
- Parameters:
value
- The time when this communication was sent.
-
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
-
hasReceived
-
setReceivedElement
- 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
- Returns:
- The time when this communication arrived at the destination.
-
setReceived
- Parameters:
value
- The time when this communication arrived at the destination.
-
getRecipient
- Returns:
recipient
(The entity (e.g. person, organization, clinical information system, care team or device) which was the target of the communication. If receipts need to be tracked by an individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either receipts are not tracked (e.g. a mass mail-out) or a receipt is captured in aggregate (all emails confirmed received by a particular time).)
-
setRecipient
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasRecipient
-
addRecipient
-
addRecipient
-
getRecipientFirstRep
- Returns:
- The first repetition of repeating field
recipient
, creating it if it does not already exist
-
getRecipientTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getSender
- Returns:
sender
(The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)
-
hasSender
-
setSender
- Parameters:
value
-sender
(The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)
-
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
- 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
- Returns:
reasonCode
(The reason or justification for the communication.)
-
setReasonCode
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonCode
-
addReasonCode
-
addReasonCode
-
getReasonCodeFirstRep
- Returns:
- The first repetition of repeating field
reasonCode
, creating it if it does not already exist
-
getReasonReference
- Returns:
reasonReference
(Indicates another resource whose existence justifies this communication.)
-
setReasonReference
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonReference
-
addReasonReference
-
addReasonReference
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
Deprecated.Use Reference#setResource(IBaseResource) instead -
getPayload
- Returns:
payload
(Text, attachment(s), or resource(s) that was communicated to the recipient.)
-
setPayload
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPayload
-
addPayload
-
addPayload
-
getPayloadFirstRep
- Returns:
- The first repetition of repeating field
payload
, creating it if it does not already exist
-
getNote
- Returns:
note
(Additional notes or commentary about the communication by the sender, receiver or other interested parties.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- 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 classDomainResource
- 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 classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-