public class Communication extends DomainResource
| Modifier and Type | Class and Description |
|---|---|
static class |
Communication.CommunicationPayloadComponent |
static class |
Communication.CommunicationStatus |
static class |
Communication.CommunicationStatusEnumFactory |
| Modifier and Type | Field and Description |
|---|---|
protected CodeableConcept |
category
The type of message conveyed such as alert, notification, reminder, instruction, etc.
|
protected Reference |
encounter
The encounter within which the communication was sent.
|
protected Encounter |
encounterTarget
The actual object that is the target of the reference (The encounter within which the communication was sent.)
|
protected List<Identifier> |
identifier
Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g.
|
protected List<CodeableConcept> |
medium
A channel that was used for this communication (e.g.
|
protected List<Communication.CommunicationPayloadComponent> |
payload
Text, attachment(s), or resource(s) that was communicated to the recipient.
|
protected List<CodeableConcept> |
reason
The reason or justification for the communication.
|
protected DateTimeType |
received
The time when this communication arrived at the destination.
|
protected List<Reference> |
recipient
The entity (e.g.
|
protected List<Resource> |
recipientTarget
The actual objects that are the target of the reference (The entity (e.g.
|
protected Reference |
requestDetail
The communication request that was responsible for producing this communication.
|
protected CommunicationRequest |
requestDetailTarget
The actual object that is the target of the reference (The communication request that was responsible for producing this communication.)
|
protected Reference |
sender
The entity (e.g.
|
protected Resource |
senderTarget
The actual object that is the target of the reference (The entity (e.g.
|
protected DateTimeType |
sent
The time when this communication was sent.
|
static String |
SP_CATEGORY |
static String |
SP_ENCOUNTER |
static String |
SP_IDENTIFIER |
static String |
SP_MEDIUM |
static String |
SP_PATIENT |
static String |
SP_RECEIVED |
static String |
SP_RECIPIENT |
static String |
SP_REQUEST |
static String |
SP_SENDER |
static String |
SP_SENT |
static String |
SP_STATUS |
static String |
SP_SUBJECT |
protected Enumeration<Communication.CommunicationStatus> |
status
The status of the transmission.
|
protected Reference |
subject
The patient who was the focus of this communication.
|
protected Patient |
subjectTarget
The actual object that is the target of the reference (The patient who was the focus of this communication.)
|
contained, extension, modifierExtension, textid, implicitRules, language, meta| Constructor and Description |
|---|
Communication() |
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setTextcopyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, getStructureFhirVersionEnum, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMetasetIdcastToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, listChildrenByName, primitiveValue, setUserData, setUserDataINNclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitgetId, getIdElement, getLanguageElement, getUserData, setId, setUserDataprotected List<Identifier> identifier
protected CodeableConcept category
protected Reference sender
protected Resource senderTarget
protected List<Reference> recipient
protected List<Resource> recipientTarget
protected List<Communication.CommunicationPayloadComponent> payload
protected List<CodeableConcept> medium
protected Enumeration<Communication.CommunicationStatus> status
protected Encounter encounterTarget
protected DateTimeType sent
protected DateTimeType received
protected List<CodeableConcept> reason
protected Patient subjectTarget
protected Reference requestDetail
protected CommunicationRequest requestDetailTarget
public static final String SP_IDENTIFIER
public static final String SP_REQUEST
public static final String SP_SENDER
public static final String SP_SUBJECT
public static final String SP_PATIENT
public static final String SP_RECIPIENT
public static final String SP_RECEIVED
public static final String SP_MEDIUM
public static final String SP_ENCOUNTER
public static final String SP_CATEGORY
public static final String SP_SENT
public static final String SP_STATUS
public Communication()
public List<Identifier> getIdentifier()
identifier (Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)public boolean hasIdentifier()
public Identifier addIdentifier()
identifier (Identifiers associated with this Communication that are defined by business processes and/ or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).)public Communication addIdentifier(Identifier t)
public CodeableConcept getCategory()
category (The type of message conveyed such as alert, notification, reminder, instruction, etc.)public boolean hasCategory()
public Communication setCategory(CodeableConcept value)
value - category (The type of message conveyed such as alert, notification, reminder, instruction, etc.)public Reference getSender()
sender (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)public boolean hasSender()
public Communication setSender(Reference value)
value - sender (The entity (e.g. person, organization, clinical information system, or device) which was the source of the communication.)public Resource getSenderTarget()
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.)public Communication setSenderTarget(Resource value)
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.)public List<Reference> getRecipient()
recipient (The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).)public boolean hasRecipient()
public Reference addRecipient()
recipient (The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).)public Communication addRecipient(Reference t)
public List<Resource> getRecipientTarget()
recipient (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. The entity (e.g. person, organization, clinical information system, or device) which was the target of the communication. If receipts need to be tracked by individual, a separate resource instance will need to be created for each recipient. Multiple recipient communications are intended where either a receipt(s) is not tracked (e.g. a mass mail-out) or is captured in aggregate (all emails confirmed received by a particular time).)public List<Communication.CommunicationPayloadComponent> getPayload()
payload (Text, attachment(s), or resource(s) that was communicated to the recipient.)public boolean hasPayload()
public Communication.CommunicationPayloadComponent addPayload()
payload (Text, attachment(s), or resource(s) that was communicated to the recipient.)public Communication addPayload(Communication.CommunicationPayloadComponent t)
public List<CodeableConcept> getMedium()
medium (A channel that was used for this communication (e.g. email, fax).)public boolean hasMedium()
public CodeableConcept addMedium()
medium (A channel that was used for this communication (e.g. email, fax).)public Communication addMedium(CodeableConcept t)
public Enumeration<Communication.CommunicationStatus> getStatusElement()
status (The status of the transmission.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the valuepublic boolean hasStatusElement()
public boolean hasStatus()
public Communication setStatusElement(Enumeration<Communication.CommunicationStatus> value)
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 valuepublic Communication.CommunicationStatus getStatus()
public Communication setStatus(Communication.CommunicationStatus value)
value - The status of the transmission.public Reference getEncounter()
encounter (The encounter within which the communication was sent.)public boolean hasEncounter()
public Communication setEncounter(Reference value)
value - encounter (The encounter within which the communication was sent.)public Encounter getEncounterTarget()
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 within which the communication was sent.)public Communication setEncounterTarget(Encounter value)
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 within which the communication was sent.)public DateTimeType getSentElement()
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 valuepublic boolean hasSentElement()
public boolean hasSent()
public Communication setSentElement(DateTimeType value)
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 valuepublic Communication setSent(Date value)
value - The time when this communication was sent.public DateTimeType getReceivedElement()
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 valuepublic boolean hasReceivedElement()
public boolean hasReceived()
public Communication setReceivedElement(DateTimeType value)
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 valuepublic Date getReceived()
public Communication setReceived(Date value)
value - The time when this communication arrived at the destination.public List<CodeableConcept> getReason()
reason (The reason or justification for the communication.)public boolean hasReason()
public CodeableConcept addReason()
reason (The reason or justification for the communication.)public Communication addReason(CodeableConcept t)
public Reference getSubject()
subject (The patient who was the focus of this communication.)public boolean hasSubject()
public Communication setSubject(Reference value)
value - subject (The patient who was the focus of this communication.)public Patient getSubjectTarget()
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 who was the focus of this communication.)public Communication setSubjectTarget(Patient value)
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 who was the focus of this communication.)public Reference getRequestDetail()
requestDetail (The communication request that was responsible for producing this communication.)public boolean hasRequestDetail()
public Communication setRequestDetail(Reference value)
value - requestDetail (The communication request that was responsible for producing this communication.)public CommunicationRequest getRequestDetailTarget()
requestDetail 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 communication request that was responsible for producing this communication.)public Communication setRequestDetailTarget(CommunicationRequest value)
value - requestDetail 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 communication request that was responsible for producing this communication.)protected void listChildren(List<Property> childrenList)
listChildren in class DomainResourcepublic void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
setProperty in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
addChild in class DomainResourceorg.hl7.fhir.exceptions.FHIRExceptionpublic String fhirType()
fhirType in class DomainResourcepublic Communication copy()
copy in class DomainResourceprotected Communication typedCopy()
public boolean equalsDeep(Base other)
equalsDeep in class DomainResourcepublic boolean equalsShallow(Base other)
equalsShallow in class DomainResourcepublic boolean isEmpty()
isEmpty in interface org.hl7.fhir.instance.model.api.IBaseisEmpty in class DomainResourcepublic ResourceType getResourceType()
getResourceType in class ResourceCopyright © 2014–2018 University Health Network. All rights reserved.