Class Communication
- java.lang.Object
-
- org.linuxforhealth.fhir.model.visitor.AbstractVisitable
-
- org.linuxforhealth.fhir.model.resource.Resource
-
- org.linuxforhealth.fhir.model.resource.DomainResource
-
- org.linuxforhealth.fhir.model.resource.Communication
-
- All Implemented Interfaces:
Visitable
@Generated("org.linuxforhealth.fhir.tools.CodeGenerator") 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.Maturity level: FMM2 (Trial Use)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Communication.Builder
static class
Communication.Payload
Text, attachment(s), or resource(s) that was communicated to the recipient.
-
Field Summary
-
Fields inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
contained, extension, modifierExtension, text
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description void
accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Accept a Visitor and invoke the appropriate visit methods.static Communication.Builder
builder()
boolean
equals(java.lang.Object obj)
java.util.List<Reference>
getAbout()
Other resources that pertain to this communication and to which this communication should be associated.java.util.List<Reference>
getBasedOn()
An order, proposal or plan fulfilled in whole or in part by this Communication.java.util.List<CodeableConcept>
getCategory()
The type of message conveyed such as alert, notification, reminder, instruction, etc.Reference
getEncounter()
The Encounter during which this Communication was created or to which the creation of this record is tightly associated.java.util.List<Identifier>
getIdentifier()
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.java.util.List<Reference>
getInResponseTo()
Prior communication that this communication is in response to.java.util.List<Canonical>
getInstantiatesCanonical()
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.java.util.List<Uri>
getInstantiatesUri()
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.java.util.List<CodeableConcept>
getMedium()
A channel that was used for this communication (e.g.java.util.List<Annotation>
getNote()
Additional notes or commentary about the communication by the sender, receiver or other interested parties.java.util.List<Reference>
getPartOf()
Part of this action.java.util.List<Communication.Payload>
getPayload()
Text, attachment(s), or resource(s) that was communicated to the recipient.CommunicationPriority
getPriority()
Characterizes how quickly the planned or in progress communication must be addressed.java.util.List<CodeableConcept>
getReasonCode()
The reason or justification for the communication.java.util.List<Reference>
getReasonReference()
Indicates another resource whose existence justifies this communication.DateTime
getReceived()
The time when this communication arrived at the destination.java.util.List<Reference>
getRecipient()
The entity (e.g.Reference
getSender()
The entity (e.g.DateTime
getSent()
The time when this communication was sent.CommunicationStatus
getStatus()
The status of the transmission.CodeableConcept
getStatusReason()
Captures the reason for the current state of the Communication.Reference
getSubject()
The patient or group that was the focus of this communication.CodeableConcept
getTopic()
Description of the purpose/content, similar to a subject line in an email.boolean
hasChildren()
int
hashCode()
Communication.Builder
toBuilder()
Create a new Builder from the contents of this Resource-
Methods inherited from class org.linuxforhealth.fhir.model.resource.DomainResource
getContained, getExtension, getModifierExtension, getText
-
Methods inherited from class org.linuxforhealth.fhir.model.resource.Resource
as, getId, getImplicitRules, getLanguage, getMeta, is
-
-
-
-
Method Detail
-
getIdentifier
public java.util.List<Identifier> getIdentifier()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Identifier
that may be empty.
-
getInstantiatesCanonical
public java.util.List<Canonical> getInstantiatesCanonical()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Canonical
that may be empty.
-
getInstantiatesUri
public java.util.List<Uri> getInstantiatesUri()
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.- Returns:
- An unmodifiable list containing immutable objects of type
Uri
that may be empty.
-
getBasedOn
public java.util.List<Reference> getBasedOn()
An order, proposal or plan fulfilled in whole or in part by this Communication.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getPartOf
public java.util.List<Reference> getPartOf()
Part of this action.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getInResponseTo
public java.util.List<Reference> getInResponseTo()
Prior communication that this communication is in response to.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getStatus
public CommunicationStatus getStatus()
The status of the transmission.- Returns:
- An immutable object of type
CommunicationStatus
that is non-null.
-
getStatusReason
public CodeableConcept getStatusReason()
Captures the reason for the current state of the Communication.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getCategory
public java.util.List<CodeableConcept> getCategory()
The type of message conveyed such as alert, notification, reminder, instruction, etc.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getPriority
public CommunicationPriority getPriority()
Characterizes how quickly the planned or in progress communication must be addressed. Includes concepts such as stat, urgent, routine.- Returns:
- An immutable object of type
CommunicationPriority
that may be null.
-
getMedium
public java.util.List<CodeableConcept> getMedium()
A channel that was used for this communication (e.g. email, fax).- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getSubject
public Reference getSubject()
The patient or group that was the focus of this communication.- Returns:
- An immutable object of type
Reference
that may be null.
-
getTopic
public CodeableConcept getTopic()
Description of the purpose/content, similar to a subject line in an email.- Returns:
- An immutable object of type
CodeableConcept
that may be null.
-
getAbout
public java.util.List<Reference> getAbout()
Other resources that pertain to this communication and to which this communication should be associated.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getEncounter
public Reference getEncounter()
The Encounter during which this Communication was created or to which the creation of this record is tightly associated.- Returns:
- An immutable object of type
Reference
that may be null.
-
getSent
public DateTime getSent()
The time when this communication was sent.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getReceived
public DateTime getReceived()
The time when this communication arrived at the destination.- Returns:
- An immutable object of type
DateTime
that may be null.
-
getRecipient
public java.util.List<Reference> getRecipient()
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).- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getSender
public Reference getSender()
The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.- Returns:
- An immutable object of type
Reference
that may be null.
-
getReasonCode
public java.util.List<CodeableConcept> getReasonCode()
The reason or justification for the communication.- Returns:
- An unmodifiable list containing immutable objects of type
CodeableConcept
that may be empty.
-
getReasonReference
public java.util.List<Reference> getReasonReference()
Indicates another resource whose existence justifies this communication.- Returns:
- An unmodifiable list containing immutable objects of type
Reference
that may be empty.
-
getPayload
public java.util.List<Communication.Payload> getPayload()
Text, attachment(s), or resource(s) that was communicated to the recipient.- Returns:
- An unmodifiable list containing immutable objects of type
Communication.Payload
that may be empty.
-
getNote
public java.util.List<Annotation> getNote()
Additional notes or commentary about the communication by the sender, receiver or other interested parties.- Returns:
- An unmodifiable list containing immutable objects of type
Annotation
that may be empty.
-
hasChildren
public boolean hasChildren()
- Overrides:
hasChildren
in classDomainResource
-
accept
public void accept(java.lang.String elementName, int elementIndex, Visitor visitor)
Description copied from interface:Visitable
Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this:if (visitor.preVisit(this)) { visitor.visitStart(elementName, elementIndex, this); if (visitor.visit(elementName, elementIndex, this)) { // visit children } visitor.visitEnd(elementName, elementIndex, this); visitor.postVisit(this); }
- Specified by:
accept
in interfaceVisitable
- Specified by:
accept
in classAbstractVisitable
- Parameters:
elementName
- the name of the element in the context of this visitelementIndex
- the index of the element in a list or -1 if it is not contained within a Listvisitor
- the visitor to use
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toBuilder
public Communication.Builder toBuilder()
Description copied from class:Resource
Create a new Builder from the contents of this Resource- Specified by:
toBuilder
in classDomainResource
-
builder
public static Communication.Builder builder()
-
-