Package org.hl7.fhir.dstu2.model
Class CommunicationRequest
- java.lang.Object
-
- org.hl7.fhir.dstu2.model.Base
-
- org.hl7.fhir.dstu2.model.BaseResource
-
- org.hl7.fhir.dstu2.model.Resource
-
- org.hl7.fhir.dstu2.model.DomainResource
-
- org.hl7.fhir.dstu2.model.CommunicationRequest
-
- 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 CommunicationRequest extends DomainResource
A request to convey information; e.g. the CDS system proposes that an alert be sent to a responsible provider, the CDS system proposes that the public health agency be notified about a reportable condition.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classCommunicationRequest.CommunicationRequestPayloadComponentstatic classCommunicationRequest.CommunicationRequestStatusstatic classCommunicationRequest.CommunicationRequestStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptcategoryThe type of message to be sent such as alert, notification, reminder, instruction, etc.protected ReferenceencounterThe encounter within which the communication request was created.protected EncounterencounterTargetThe actual object that is the target of the reference (The encounter within which the communication request was created.)protected List<Identifier>identifierA unique ID of this request for reference purposes.protected List<CodeableConcept>mediumA channel that was used for this communication (e.g.protected List<CommunicationRequest.CommunicationRequestPayloadComponent>payloadText, attachment(s), or resource(s) to be communicated to the recipient.protected CodeableConceptpriorityCharacterizes how quickly the proposed act must be initiated.protected List<CodeableConcept>reasonThe reason or justification for the communication request.protected List<Reference>recipientThe entity (e.g.protected List<Resource>recipientTargetThe actual objects that are the target of the reference (The entity (e.g.protected DateTimeTyperequestedOnThe time when the request was made.protected ReferencerequesterThe responsible person who authorizes this order, e.g.protected ResourcerequesterTargetThe actual object that is the target of the reference (The responsible person who authorizes this order, e.g.protected TypescheduledThe time when this communication is to occur.protected ReferencesenderThe entity (e.g.protected ResourcesenderTargetThe actual object that is the target of the reference (The entity (e.g.static StringSP_CATEGORYstatic StringSP_ENCOUNTERstatic StringSP_IDENTIFIERstatic StringSP_MEDIUMstatic StringSP_PATIENTstatic StringSP_PRIORITYstatic StringSP_RECIPIENTstatic StringSP_REQUESTEDstatic StringSP_REQUESTERstatic StringSP_SENDERstatic StringSP_STATUSstatic StringSP_SUBJECTstatic StringSP_TIMEprotected Enumeration<CommunicationRequest.CommunicationRequestStatus>statusThe status of the proposal or order.protected ReferencesubjectThe patient who is the focus of this communication request.protected PatientsubjectTargetThe actual object that is the target of the reference (The patient who is the focus of this communication request.)-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description CommunicationRequest()
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, 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, 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
A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.
-
category
protected CodeableConcept category
The type of message to be sent such as alert, notification, reminder, instruction, etc.
-
sender
protected Reference sender
The entity (e.g. person, organization, clinical information system, or device) which is to be 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 is to be the source of the communication.)
-
recipient
protected List<Reference> recipient
The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.
-
recipientTarget
protected List<Resource> recipientTarget
The actual objects that are the target of the reference (The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.)
-
payload
protected List<CommunicationRequest.CommunicationRequestPayloadComponent> payload
Text, attachment(s), or resource(s) to be communicated to the recipient.
-
medium
protected List<CodeableConcept> medium
A channel that was used for this communication (e.g. email, fax).
-
requester
protected Reference requester
The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.
-
requesterTarget
protected Resource requesterTarget
The actual object that is the target of the reference (The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.)
-
status
protected Enumeration<CommunicationRequest.CommunicationRequestStatus> status
The status of the proposal or order.
-
encounter
protected Reference encounter
The encounter within which the communication request was created.
-
encounterTarget
protected Encounter encounterTarget
The actual object that is the target of the reference (The encounter within which the communication request was created.)
-
reason
protected List<CodeableConcept> reason
The reason or justification for the communication request.
-
requestedOn
protected DateTimeType requestedOn
The time when the request was made.
-
subjectTarget
protected Patient subjectTarget
The actual object that is the target of the reference (The patient who is the focus of this communication request.)
-
priority
protected CodeableConcept priority
Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.
-
SP_REQUESTER
public static final String SP_REQUESTER
- See Also:
- Constant Field Values
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
- See Also:
- Constant Field Values
-
SP_SUBJECT
public static final String SP_SUBJECT
- See Also:
- Constant Field Values
-
SP_MEDIUM
public static final String SP_MEDIUM
- See Also:
- Constant Field Values
-
SP_ENCOUNTER
public static final String SP_ENCOUNTER
- See Also:
- Constant Field Values
-
SP_PRIORITY
public static final String SP_PRIORITY
- See Also:
- Constant Field Values
-
SP_REQUESTED
public static final String SP_REQUESTED
- See Also:
- Constant Field Values
-
SP_SENDER
public static final String SP_SENDER
- See Also:
- Constant Field Values
-
SP_PATIENT
public static final String SP_PATIENT
- See Also:
- Constant Field Values
-
SP_RECIPIENT
public static final String SP_RECIPIENT
- See Also:
- Constant Field Values
-
SP_TIME
public static final String SP_TIME
- See Also:
- Constant Field Values
-
SP_CATEGORY
public static final String SP_CATEGORY
- See Also:
- Constant Field Values
-
SP_STATUS
public static final String SP_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CommunicationRequest
public CommunicationRequest()
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(A unique ID of this request for reference purposes. It must be provided if user wants it returned as part of any output, otherwise it will be autogenerated, if needed, by CDS system. Does not need to be the actual ID of the source system.)
-
addIdentifier
public CommunicationRequest addIdentifier(Identifier t)
-
getCategory
public CodeableConcept getCategory()
- Returns:
category(The type of message to be sent such as alert, notification, reminder, instruction, etc.)
-
hasCategory
public boolean hasCategory()
-
setCategory
public CommunicationRequest setCategory(CodeableConcept value)
- Parameters:
value-category(The type of message to be sent such as alert, notification, reminder, instruction, etc.)
-
getSender
public Reference getSender()
- Returns:
sender(The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.)
-
hasSender
public boolean hasSender()
-
setSender
public CommunicationRequest setSender(Reference value)
- Parameters:
value-sender(The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication.)
-
getSenderTarget
public Resource getSenderTarget()
- Returns:
senderThe 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 is to be the source of the communication.)
-
setSenderTarget
public CommunicationRequest setSenderTarget(Resource value)
- Parameters:
value-senderThe 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 is to be the source of the communication.)
-
getRecipient
public List<Reference> getRecipient()
- Returns:
recipient(The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.)
-
hasRecipient
public boolean hasRecipient()
-
addRecipient
public Reference addRecipient()
- Returns:
recipient(The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication.)
-
addRecipient
public CommunicationRequest addRecipient(Reference t)
-
getRecipientTarget
public List<Resource> getRecipientTarget()
- Returns:
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 is the intended target of the communication.)
-
getPayload
public List<CommunicationRequest.CommunicationRequestPayloadComponent> getPayload()
- Returns:
payload(Text, attachment(s), or resource(s) to be communicated to the recipient.)
-
hasPayload
public boolean hasPayload()
-
addPayload
public CommunicationRequest.CommunicationRequestPayloadComponent addPayload()
- Returns:
payload(Text, attachment(s), or resource(s) to be communicated to the recipient.)
-
addPayload
public CommunicationRequest addPayload(CommunicationRequest.CommunicationRequestPayloadComponent t)
-
getMedium
public List<CodeableConcept> getMedium()
- Returns:
medium(A channel that was used for this communication (e.g. email, fax).)
-
hasMedium
public boolean hasMedium()
-
addMedium
public CodeableConcept addMedium()
- Returns:
medium(A channel that was used for this communication (e.g. email, fax).)
-
addMedium
public CommunicationRequest addMedium(CodeableConcept t)
-
getRequester
public Reference getRequester()
- Returns:
requester(The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.)
-
hasRequester
public boolean hasRequester()
-
setRequester
public CommunicationRequest setRequester(Reference value)
- Parameters:
value-requester(The responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.)
-
getRequesterTarget
public Resource getRequesterTarget()
- Returns:
requesterThe 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 responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.)
-
setRequesterTarget
public CommunicationRequest setRequesterTarget(Resource value)
- Parameters:
value-requesterThe 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 responsible person who authorizes this order, e.g. physician. This may be different than the author of the order statement, e.g. clerk, who may have entered the statement into the order entry application.)
-
getStatusElement
public Enumeration<CommunicationRequest.CommunicationRequestStatus> getStatusElement()
- Returns:
status(The status of the proposal or order.). 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 CommunicationRequest setStatusElement(Enumeration<CommunicationRequest.CommunicationRequestStatus> value)
- Parameters:
value-status(The status of the proposal or order.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public CommunicationRequest.CommunicationRequestStatus getStatus()
- Returns:
- The status of the proposal or order.
-
setStatus
public CommunicationRequest setStatus(CommunicationRequest.CommunicationRequestStatus value)
- Parameters:
value- The status of the proposal or order.
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(The encounter within which the communication request was created.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public CommunicationRequest setEncounter(Reference value)
- Parameters:
value-encounter(The encounter within which the communication request was created.)
-
getEncounterTarget
public Encounter getEncounterTarget()
- Returns:
encounterThe 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 request was created.)
-
setEncounterTarget
public CommunicationRequest setEncounterTarget(Encounter value)
- Parameters:
value-encounterThe 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 request was created.)
-
getScheduled
public Type getScheduled()
- Returns:
scheduled(The time when this communication is to occur.)
-
getScheduledDateTimeType
public DateTimeType getScheduledDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
scheduled(The time when this communication is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasScheduledDateTimeType
public boolean hasScheduledDateTimeType()
-
getScheduledPeriod
public Period getScheduledPeriod() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
scheduled(The time when this communication is to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasScheduledPeriod
public boolean hasScheduledPeriod()
-
hasScheduled
public boolean hasScheduled()
-
setScheduled
public CommunicationRequest setScheduled(Type value)
- Parameters:
value-scheduled(The time when this communication is to occur.)
-
getReason
public List<CodeableConcept> getReason()
- Returns:
reason(The reason or justification for the communication request.)
-
hasReason
public boolean hasReason()
-
addReason
public CodeableConcept addReason()
- Returns:
reason(The reason or justification for the communication request.)
-
addReason
public CommunicationRequest addReason(CodeableConcept t)
-
getRequestedOnElement
public DateTimeType getRequestedOnElement()
- Returns:
requestedOn(The time when the request was made.). This is the underlying object with id, value and extensions. The accessor "getRequestedOn" gives direct access to the value
-
hasRequestedOnElement
public boolean hasRequestedOnElement()
-
hasRequestedOn
public boolean hasRequestedOn()
-
setRequestedOnElement
public CommunicationRequest setRequestedOnElement(DateTimeType value)
- Parameters:
value-requestedOn(The time when the request was made.). This is the underlying object with id, value and extensions. The accessor "getRequestedOn" gives direct access to the value
-
getRequestedOn
public Date getRequestedOn()
- Returns:
- The time when the request was made.
-
setRequestedOn
public CommunicationRequest setRequestedOn(Date value)
- Parameters:
value- The time when the request was made.
-
getSubject
public Reference getSubject()
- Returns:
subject(The patient who is the focus of this communication request.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public CommunicationRequest setSubject(Reference value)
- Parameters:
value-subject(The patient who is the focus of this communication request.)
-
getSubjectTarget
public Patient getSubjectTarget()
- Returns:
subjectThe 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 is the focus of this communication request.)
-
setSubjectTarget
public CommunicationRequest setSubjectTarget(Patient value)
- Parameters:
value-subjectThe 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 is the focus of this communication request.)
-
getPriority
public CodeableConcept getPriority()
- Returns:
priority(Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.)
-
hasPriority
public boolean hasPriority()
-
setPriority
public CommunicationRequest setPriority(CodeableConcept value)
- Parameters:
value-priority(Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public CommunicationRequest copy()
- Specified by:
copyin classDomainResource
-
typedCopy
protected CommunicationRequest typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-