Class CommunicationRequest

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.CommunicationRequest
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

public class CommunicationRequest
extends BaseResource
implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR CommunicationRequest Resource ()

Definition: 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.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/CommunicationRequest

See Also:
Serialized Form
  • Field Details

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description:
      Type: token
      Path: CommunicationRequest.identifier

      See Also:
      Constant Field Values
    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description:
      Type: token
      Path: CommunicationRequest.identifier

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter constant for category

      Description:
      Type: token
      Path: CommunicationRequest.category

      See Also:
      Constant Field Values
    • CATEGORY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
      Fluent Client search parameter constant for category

      Description:
      Type: token
      Path: CommunicationRequest.category

    • SP_SENDER

      public static final String SP_SENDER
      Search parameter constant for sender

      Description:
      Type: reference
      Path: CommunicationRequest.sender

      See Also:
      Constant Field Values
    • SENDER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SENDER
      Fluent Client search parameter constant for sender

      Description:
      Type: reference
      Path: CommunicationRequest.sender

    • SP_RECIPIENT

      public static final String SP_RECIPIENT
      Search parameter constant for recipient

      Description:
      Type: reference
      Path: CommunicationRequest.recipient

      See Also:
      Constant Field Values
    • RECIPIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam RECIPIENT
      Fluent Client search parameter constant for recipient

      Description:
      Type: reference
      Path: CommunicationRequest.recipient

    • SP_MEDIUM

      public static final String SP_MEDIUM
      Search parameter constant for medium

      Description:
      Type: token
      Path: CommunicationRequest.medium

      See Also:
      Constant Field Values
    • MEDIUM

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam MEDIUM
      Fluent Client search parameter constant for medium

      Description:
      Type: token
      Path: CommunicationRequest.medium

    • SP_REQUESTER

      public static final String SP_REQUESTER
      Search parameter constant for requester

      Description:
      Type: reference
      Path: CommunicationRequest.requester

      See Also:
      Constant Field Values
    • REQUESTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REQUESTER
      Fluent Client search parameter constant for requester

      Description:
      Type: reference
      Path: CommunicationRequest.requester

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter constant for status

      Description:
      Type: token
      Path: CommunicationRequest.status

      See Also:
      Constant Field Values
    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description:
      Type: token
      Path: CommunicationRequest.status

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter constant for encounter

      Description:
      Type: reference
      Path: CommunicationRequest.encounter

      See Also:
      Constant Field Values
    • ENCOUNTER

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
      Fluent Client search parameter constant for encounter

      Description:
      Type: reference
      Path: CommunicationRequest.encounter

    • SP_TIME

      public static final String SP_TIME
      Search parameter constant for time

      Description:
      Type: date
      Path: CommunicationRequest.scheduledDateTime

      See Also:
      Constant Field Values
    • TIME

      public static final ca.uhn.fhir.rest.gclient.DateClientParam TIME
      Fluent Client search parameter constant for time

      Description:
      Type: date
      Path: CommunicationRequest.scheduledDateTime

    • SP_REQUESTED

      public static final String SP_REQUESTED
      Search parameter constant for requested

      Description:
      Type: date
      Path: CommunicationRequest.requestedOn

      See Also:
      Constant Field Values
    • REQUESTED

      public static final ca.uhn.fhir.rest.gclient.DateClientParam REQUESTED
      Fluent Client search parameter constant for requested

      Description:
      Type: date
      Path: CommunicationRequest.requestedOn

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter constant for subject

      Description:
      Type: reference
      Path: CommunicationRequest.subject

      See Also:
      Constant Field Values
    • SUBJECT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
      Fluent Client search parameter constant for subject

      Description:
      Type: reference
      Path: CommunicationRequest.subject

    • SP_PRIORITY

      public static final String SP_PRIORITY
      Search parameter constant for priority

      Description:
      Type: token
      Path: CommunicationRequest.priority

      See Also:
      Constant Field Values
    • PRIORITY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam PRIORITY
      Fluent Client search parameter constant for priority

      Description:
      Type: token
      Path: CommunicationRequest.priority

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

      Description:
      Type: reference
      Path: CommunicationRequest.subject

      See Also:
      Constant Field Values
    • PATIENT

      public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
      Fluent Client search parameter constant for patient

      Description:
      Type: reference
      Path: CommunicationRequest.subject

    • 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 "CommunicationRequest:encounter".
    • 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 "CommunicationRequest:patient".
    • 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 "CommunicationRequest:recipient".
    • INCLUDE_REQUESTER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_REQUESTER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "CommunicationRequest:requester".
    • 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 "CommunicationRequest:sender".
    • 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 "CommunicationRequest:subject".
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getIdentifier

      Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setIdentifier

      Sets the value(s) for identifier ()

      Definition: 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

      Adds and returns a new value for identifier ()

      Definition: 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

      Adds a given new value for identifier ()

      Definition: 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.

      Parameters:
      theValue - The identifier to add (must not be null)
    • getIdentifierFirstRep

      Gets the first repetition for identifier (), creating it if it does not already exist.

      Definition: 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.

    • getCategory

      Gets the value(s) for category (). creating it if it does not exist. Will not return null.

      Definition: The type of message to be sent such as alert, notification, reminder, instruction, etc.

    • setCategory

      Sets the value(s) for category ()

      Definition: The type of message to be sent such as alert, notification, reminder, instruction, etc.

    • getSender

      Gets the value(s) for sender (). creating it if it does not exist. Will not return null.

      Definition: The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication

    • setSender

      Sets the value(s) for sender ()

      Definition: The entity (e.g. person, organization, clinical information system, or device) which is to be the source of the communication

    • getRecipient

      Gets the value(s) for recipient (). creating it if it does not exist. Will not return null.

      Definition: The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication

    • setRecipient

      Sets the value(s) for recipient ()

      Definition: The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication

    • addRecipient

      Adds and returns a new value for recipient ()

      Definition: The entity (e.g. person, organization, clinical information system, or device) which is the intended target of the communication

    • getPayload

      Gets the value(s) for payload (). creating it if it does not exist. Will not return null.

      Definition: Text, attachment(s), or resource(s) to be communicated to the recipient

    • setPayload

      Sets the value(s) for payload ()

      Definition: Text, attachment(s), or resource(s) to be communicated to the recipient

    • addPayload

      Adds and returns a new value for payload ()

      Definition: Text, attachment(s), or resource(s) to be communicated to the recipient

    • addPayload

      Adds a given new value for payload ()

      Definition: Text, attachment(s), or resource(s) to be communicated to the recipient

      Parameters:
      theValue - The payload to add (must not be null)
    • getPayloadFirstRep

      Gets the first repetition for payload (), creating it if it does not already exist.

      Definition: Text, attachment(s), or resource(s) to be communicated to the recipient

    • getMedium

      Gets the value(s) for medium (). creating it if it does not exist. Will not return null.

      Definition: A channel that was used for this communication (e.g. email, fax).

    • setMedium

      Sets the value(s) for medium ()

      Definition: A channel that was used for this communication (e.g. email, fax).

    • addMedium

      Adds and returns a new value for medium ()

      Definition: A channel that was used for this communication (e.g. email, fax).

    • addMedium

      Adds a given new value for medium ()

      Definition: A channel that was used for this communication (e.g. email, fax).

      Parameters:
      theValue - The medium to add (must not be null)
    • getMediumFirstRep

      Gets the first repetition for medium (), creating it if it does not already exist.

      Definition: A channel that was used for this communication (e.g. email, fax).

    • getRequester

      Gets the value(s) for requester (). creating it if it does not exist. Will not return null.

      Definition: 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.

    • setRequester

      Sets the value(s) for requester ()

      Definition: 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 ca.uhn.fhir.model.primitive.BoundCodeDt<CommunicationRequestStatusEnum> getStatusElement()
      Gets the value(s) for status (). creating it if it does not exist. Will not return null.

      Definition: The status of the proposal or order.

    • getStatus

      public String getStatus()
      Gets the value(s) for status (). creating it if it does not exist. This method may return null.

      Definition: The status of the proposal or order.

    • setStatus

      public CommunicationRequest setStatus​(ca.uhn.fhir.model.primitive.BoundCodeDt<CommunicationRequestStatusEnum> theValue)
      Sets the value(s) for status ()

      Definition: The status of the proposal or order.

    • setStatus

      Sets the value(s) for status ()

      Definition: The status of the proposal or order.

    • getEncounter

      Gets the value(s) for encounter (). creating it if it does not exist. Will not return null.

      Definition: The encounter within which the communication request was created.

    • setEncounter

      Sets the value(s) for encounter ()

      Definition: The encounter within which the communication request was created.

    • getScheduled

      public ca.uhn.fhir.model.api.IDatatype getScheduled()
      Gets the value(s) for scheduled[x] (). creating it if it does not exist. Will not return null.

      Definition: The time when this communication is to occur.

    • setScheduled

      public CommunicationRequest setScheduled​(ca.uhn.fhir.model.api.IDatatype theValue)
      Sets the value(s) for scheduled[x] ()

      Definition: The time when this communication is to occur.

    • getReason

      Gets the value(s) for reason (). creating it if it does not exist. Will not return null.

      Definition: The reason or justification for the communication request.

    • setReason

      Sets the value(s) for reason ()

      Definition: The reason or justification for the communication request.

    • addReason

      Adds and returns a new value for reason ()

      Definition: The reason or justification for the communication request.

    • addReason

      Adds a given new value for reason ()

      Definition: The reason or justification for the communication request.

      Parameters:
      theValue - The reason to add (must not be null)
    • getReasonFirstRep

      Gets the first repetition for reason (), creating it if it does not already exist.

      Definition: The reason or justification for the communication request.

    • getRequestedOnElement

      public ca.uhn.fhir.model.primitive.DateTimeDt getRequestedOnElement()
      Gets the value(s) for requestedOn (). creating it if it does not exist. Will not return null.

      Definition: The time when the request was made.

    • getRequestedOn

      public Date getRequestedOn()
      Gets the value(s) for requestedOn (). creating it if it does not exist. This method may return null.

      Definition: The time when the request was made.

    • setRequestedOn

      public CommunicationRequest setRequestedOn​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for requestedOn ()

      Definition: The time when the request was made.

    • setRequestedOn

      public CommunicationRequest setRequestedOn​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for requestedOn ()

      Definition: The time when the request was made.

    • setRequestedOnWithSecondsPrecision

      Sets the value for requestedOn ()

      Definition: The time when the request was made.

    • getSubject

      Gets the value(s) for subject (). creating it if it does not exist. Will not return null.

      Definition: The patient who is the focus of this communication request.

    • setSubject

      Sets the value(s) for subject ()

      Definition: The patient who is the focus of this communication request.

    • getPriority

      Gets the value(s) for priority (). creating it if it does not exist. Will not return null.

      Definition: Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

    • setPriority

      Sets the value(s) for priority ()

      Definition: Characterizes how quickly the proposed act must be initiated. Includes concepts such as stat, urgent, routine.

    • getResourceName

      Specified by:
      getResourceName in interface ca.uhn.fhir.model.api.IResource
    • getStructureFhirVersionEnum

      public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
      Specified by:
      getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
      Specified by:
      getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource