Class Communication
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.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 that 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 class
Communication.CommunicationPriority
static class
Communication.CommunicationPriorityEnumFactory
static class
Communication.CommunicationStatus
static class
Communication.CommunicationStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected List<Reference>
about
Other resources that pertain to this communication and to which this communication should be associated.protected List<Resource>
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.)static ca.uhn.fhir.rest.gclient.ReferenceClientParam
BASED_ON
Fluent Client search parameter constant for based-onprotected 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 ca.uhn.fhir.rest.gclient.TokenClientParam
CATEGORY
Fluent Client search parameter constant for categoryprotected Reference
encounter
The Encounter during which this Communication was created or to which the creation of this record is tightly associated.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
ENCOUNTER
Fluent Client search parameter constant for encounterprotected Encounter
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.)protected List<Identifier>
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 ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_INSTANTIATES_CANONICAL
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_RECIPIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SENDER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.protected List<Reference>
inResponseTo
Prior communication that this communication is in response to.protected List<Communication>
inResponseToTarget
The actual objects that are the target of the reference (Prior communication that this communication is in response to.)static ca.uhn.fhir.rest.gclient.ReferenceClientParam
INSTANTIATES_CANONICAL
Fluent Client search parameter constant for instantiates-canonicalstatic ca.uhn.fhir.rest.gclient.UriClientParam
INSTANTIATES_URI
Fluent Client search parameter constant for instantiates-uriprotected List<CanonicalType>
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.protected List<UriType>
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.protected List<CodeableConcept>
medium
A channel that was used for this communication (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParam
MEDIUM
Fluent Client search parameter constant for mediumprotected List<Annotation>
note
Additional notes or commentary about the communication by the sender, receiver or other interested parties.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PART_OF
Fluent Client search parameter constant for part-ofprotected 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientprotected List<Communication.CommunicationPayloadComponent>
payload
Text, attachment(s), or resource(s) that was communicated to the recipient.protected Enumeration<Communication.CommunicationPriority>
priority
Characterizes how quickly the planned or in progress communication must be addressed.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 ca.uhn.fhir.rest.gclient.DateClientParam
RECEIVED
Fluent Client search parameter constant for receivedprotected List<Reference>
recipient
The entity (e.g.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
RECIPIENT
Fluent Client search parameter constant for recipientprotected 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam
SENDER
Fluent Client search parameter constant for senderprotected 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 ca.uhn.fhir.rest.gclient.DateClientParam
SENT
Fluent Client search parameter constant for sentstatic String
SP_BASED_ON
Search parameter: based-onstatic String
SP_CATEGORY
Search parameter: categorystatic String
SP_ENCOUNTER
Search parameter: encounterstatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_INSTANTIATES_CANONICAL
Search parameter: instantiates-canonicalstatic String
SP_INSTANTIATES_URI
Search parameter: instantiates-uristatic String
SP_MEDIUM
Search parameter: mediumstatic String
SP_PART_OF
Search parameter: part-ofstatic String
SP_PATIENT
Search parameter: patientstatic String
SP_RECEIVED
Search parameter: receivedstatic String
SP_RECIPIENT
Search parameter: recipientstatic String
SP_SENDER
Search parameter: senderstatic String
SP_SENT
Search parameter: sentstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUBJECT
Search parameter: subjectprotected Enumeration<Communication.CommunicationStatus>
status
The status of the transmission.static ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected CodeableConcept
statusReason
Captures the reason for the current state of the Communication.protected Reference
subject
The patient or group that was the focus of this communication.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectprotected Resource
subjectTarget
The actual object that is the target of the reference (The patient or group that was the focus of this communication.)protected CodeableConcept
topic
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
-
-
Constructor Summary
Constructors Constructor Description Communication()
ConstructorCommunication(Enumeration<Communication.CommunicationStatus> status)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, 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, 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, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> 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
protected List<CanonicalType> 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
protected List<UriType> 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
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.)
-
partOfTarget
protected List<Resource> partOfTarget
The actual objects that are the target of the reference (Part of this action.)
-
inResponseTo
protected List<Reference> inResponseTo
Prior communication that this communication is in response to.
-
inResponseToTarget
protected List<Communication> inResponseToTarget
The actual objects that are the target of the reference (Prior communication that this communication is in response to.)
-
status
protected Enumeration<Communication.CommunicationStatus> status
The status of the transmission.
-
statusReason
protected CodeableConcept statusReason
Captures the reason for the current state of the Communication.
-
category
protected List<CodeableConcept> category
The type of message conveyed such as alert, notification, reminder, instruction, etc.
-
priority
protected Enumeration<Communication.CommunicationPriority> priority
Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
-
medium
protected List<CodeableConcept> medium
A channel that was used for this communication (e.g. email, fax).
-
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.)
-
topic
protected CodeableConcept topic
Description of the purpose/content, similar to a subject line in an email.
-
about
protected List<Reference> about
Other resources that pertain to this communication and to which this communication should be associated.
-
aboutTarget
protected List<Resource> 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
protected Reference encounter
The Encounter during which this Communication was created or to which the creation of this record is tightly associated.
-
encounterTarget
protected Encounter 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
protected DateTimeType sent
The time when this communication was sent.
-
received
protected DateTimeType received
The time when this communication arrived at the destination.
-
recipient
protected List<Reference> 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
protected List<Resource> 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
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: identifierDescription: 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 identifierDescription: Unique identifier
Type: token
Path: Communication.identifier
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: 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 subjectDescription: 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_INSTANTIATES_CANONICAL
public static final String SP_INSTANTIATES_CANONICAL
Search parameter: instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: Communication.instantiatesCanonical
- See Also:
- Constant Field Values
-
INSTANTIATES_CANONICAL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL
Fluent Client search parameter constant for instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: Communication.instantiatesCanonical
-
INCLUDE_INSTANTIATES_CANONICAL
public static final ca.uhn.fhir.model.api.Include INCLUDE_INSTANTIATES_CANONICAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "Communication:instantiates-canonical".
-
SP_RECEIVED
public static final String SP_RECEIVED
Search parameter: receivedDescription: 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 receivedDescription: When received
Type: date
Path: Communication.received
-
SP_PART_OF
public static final String SP_PART_OF
Search parameter: part-ofDescription: 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-ofDescription: 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: mediumDescription: 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 mediumDescription: A channel of communication
Type: token
Path: Communication.medium
-
SP_ENCOUNTER
public static final String SP_ENCOUNTER
Search parameter: encounterDescription: Encounter created as part of
Type: reference
Path: Communication.encounter
- See Also:
- Constant Field Values
-
ENCOUNTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Encounter created as part of
Type: reference
Path: Communication.encounter
-
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: sentDescription: 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 sentDescription: When sent
Type: date
Path: Communication.sent
-
SP_BASED_ON
public static final String SP_BASED_ON
Search parameter: based-onDescription: 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-onDescription: 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: senderDescription: 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 senderDescription: 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: patientDescription: 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 patientDescription: 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: recipientDescription: 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 recipientDescription: 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_INSTANTIATES_URI
public static final String SP_INSTANTIATES_URI
Search parameter: instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: Communication.instantiatesUri
- See Also:
- Constant Field Values
-
INSTANTIATES_URI
public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI
Fluent Client search parameter constant for instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: Communication.instantiatesUri
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: 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 categoryDescription: Message category
Type: token
Path: Communication.category
-
SP_STATUS
public static final String 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:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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 Detail
-
Communication
public Communication()
Constructor
-
Communication
public Communication(Enumeration<Communication.CommunicationStatus> status)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> 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
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
-
getInstantiatesCanonical
public List<CanonicalType> 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
public Communication setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesCanonical
public boolean hasInstantiatesCanonical()
-
addInstantiatesCanonicalElement
public CanonicalType 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
public Communication addInstantiatesCanonical(String value)
- 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
public boolean hasInstantiatesCanonical(String value)
- 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
public List<UriType> 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
public Communication setInstantiatesUri(List<UriType> theInstantiatesUri)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesUri
public boolean hasInstantiatesUri()
-
addInstantiatesUriElement
public UriType 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
public Communication addInstantiatesUri(String value)
- 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
public boolean hasInstantiatesUri(String value)
- 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
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
-
setPartOf
public Communication setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
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
-
getInResponseTo
public List<Reference> getInResponseTo()
- Returns:
inResponseTo
(Prior communication that this communication is in response to.)
-
setInResponseTo
public Communication setInResponseTo(List<Reference> theInResponseTo)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInResponseTo
public boolean hasInResponseTo()
-
addInResponseTo
public Reference addInResponseTo()
-
addInResponseTo
public Communication addInResponseTo(Reference t)
-
getInResponseToFirstRep
public Reference getInResponseToFirstRep()
- Returns:
- The first repetition of repeating field
inResponseTo
, creating it if it does not already exist
-
getInResponseToTarget
@Deprecated public List<Communication> getInResponseToTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addInResponseToTarget
@Deprecated public Communication addInResponseToTarget()
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.
-
getStatusReason
public CodeableConcept getStatusReason()
- Returns:
statusReason
(Captures the reason for the current state of the Communication.)
-
hasStatusReason
public boolean hasStatusReason()
-
setStatusReason
public Communication setStatusReason(CodeableConcept value)
- Parameters:
value
-statusReason
(Captures the reason for the current state of the Communication.)
-
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
-
getPriorityElement
public Enumeration<Communication.CommunicationPriority> 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
public boolean hasPriorityElement()
-
hasPriority
public boolean hasPriority()
-
setPriorityElement
public Communication setPriorityElement(Enumeration<Communication.CommunicationPriority> value)
- 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
public Communication.CommunicationPriority getPriority()
- Returns:
- Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
-
setPriority
public Communication setPriority(Communication.CommunicationPriority value)
- Parameters:
value
- Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.
-
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.)
-
getTopic
public CodeableConcept getTopic()
- Returns:
topic
(Description of the purpose/content, similar to a subject line in an email.)
-
hasTopic
public boolean hasTopic()
-
setTopic
public Communication setTopic(CodeableConcept value)
- Parameters:
value
-topic
(Description of the purpose/content, similar to a subject line in an email.)
-
getAbout
public List<Reference> getAbout()
- Returns:
about
(Other resources that pertain to this communication and to which this communication should be associated.)
-
setAbout
public Communication setAbout(List<Reference> theAbout)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasAbout
public boolean hasAbout()
-
addAbout
public Communication addAbout(Reference t)
-
getAboutFirstRep
public Reference getAboutFirstRep()
- Returns:
- The first repetition of repeating field
about
, creating it if it does not already exist
-
getAboutTarget
@Deprecated public List<Resource> getAboutTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getEncounter
public Reference getEncounter()
- Returns:
encounter
(The Encounter during which this Communication was created or to which the creation of this record is tightly associated.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public Communication setEncounter(Reference value)
- Parameters:
value
-encounter
(The Encounter during which this Communication was created or to which the creation of this record is tightly associated.)
-
getEncounterTarget
public Encounter 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
public Communication setEncounterTarget(Encounter value)
- 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
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
-
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.
-
getRecipient
public List<Reference> 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
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
-
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 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
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- 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
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public Communication copy()
- Specified by:
copy
in classDomainResource
-
copyValues
public void copyValues(Communication dst)
-
typedCopy
protected Communication typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-