Package ca.uhn.fhir.model.dstu2.resource

Class ProcessRequest

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.dstu2.resource.BaseResource
ca.uhn.fhir.model.dstu2.resource.ProcessRequest
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 ProcessRequest extends BaseResource implements ca.uhn.fhir.model.api.IResource
HAPI/FHIR ProcessRequest Resource ()

Definition: This resource provides the target, request and response, and action details for an action to be performed by the target on or about existing resources.

Requirements:

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

See Also:
Serialized Form

  • Field Details

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description: The business identifier of the ProcessRequest
      Type: token
      Path: ProcessRequest.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: The business identifier of the ProcessRequest
      Type: token
      Path: ProcessRequest.identifier

    • SP_ORGANIZATION

      public static final String SP_ORGANIZATION
      Search parameter constant for organization

      Description: The organization who generated this request
      Type: reference
      Path: ProcessRequest.organization

      See Also:
      Constant Field Values

    • ORGANIZATION

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

      Description: The organization who generated this request
      Type: reference
      Path: ProcessRequest.organization

    • SP_PROVIDER

      public static final String SP_PROVIDER
      Search parameter constant for provider

      Description: The provider who regenerated this request
      Type: reference
      Path: ProcessRequest.provider

      See Also:
      Constant Field Values

    • PROVIDER

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

      Description: The provider who regenerated this request
      Type: reference
      Path: ProcessRequest.provider

    • SP_ACTION

      public static final String SP_ACTION
      Search parameter constant for action

      Description: The action requested by this resource
      Type: token
      Path: ProcessRequest.action

      See Also:
      Constant Field Values

    • ACTION

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

      Description: The action requested by this resource
      Type: token
      Path: ProcessRequest.action

    • INCLUDE_ORGANIZATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_ORGANIZATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessRequest:organization".

    • INCLUDE_PROVIDER

      public static final ca.uhn.fhir.model.api.Include INCLUDE_PROVIDER
      Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcessRequest:provider".

  • 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

    • getActionElement

      public ca.uhn.fhir.model.primitive.BoundCodeDt<ActionListEnum> getActionElement()
      Gets the value(s) for action (). creating it if it does not exist. Will not return null.

      Definition: The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest

    • getAction

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

      Definition: The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest

    • setAction

      public ProcessRequest setAction​(ca.uhn.fhir.model.primitive.BoundCodeDt<ActionListEnum> theValue)
      Sets the value(s) for action ()

      Definition: The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest

    • setAction

      public ProcessRequest setAction​(ActionListEnum theValue)
      Sets the value(s) for action ()

      Definition: The type of processing action being requested, for example Reversal, Readjudication, StatusRequest,PendedRequest

    • getIdentifier

      public List<IdentifierDt> getIdentifier()
      Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

      Definition: The ProcessRequest business identifier

    • setIdentifier

      public ProcessRequest setIdentifier​(List<IdentifierDt> theValue)
      Sets the value(s) for identifier ()

      Definition: The ProcessRequest business identifier

    • addIdentifier

      public IdentifierDt addIdentifier()
      Adds and returns a new value for identifier ()

      Definition: The ProcessRequest business identifier

    • addIdentifier

      public ProcessRequest addIdentifier​(IdentifierDt theValue)
      Adds a given new value for identifier ()

      Definition: The ProcessRequest business identifier

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

    • getIdentifierFirstRep

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

      Definition: The ProcessRequest business identifier

    • getRuleset

      public CodingDt getRuleset()
      Gets the value(s) for ruleset (). creating it if it does not exist. Will not return null.

      Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.

    • setRuleset

      public ProcessRequest setRuleset​(CodingDt theValue)
      Sets the value(s) for ruleset ()

      Definition: The version of the style of resource contents. This should be mapped to the allowable profiles for this and supporting resources.

    • getOriginalRuleset

      public CodingDt getOriginalRuleset()
      Gets the value(s) for originalRuleset (). creating it if it does not exist. Will not return null.

      Definition: The style (standard) and version of the original material which was converted into this resource.

    • setOriginalRuleset

      public ProcessRequest setOriginalRuleset​(CodingDt theValue)
      Sets the value(s) for originalRuleset ()

      Definition: The style (standard) and version of the original material which was converted into this resource.

    • getCreatedElement

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

      Definition: The date when this resource was created.

    • getCreated

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

      Definition: The date when this resource was created.

    • setCreated

      public ProcessRequest setCreated​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
      Sets the value(s) for created ()

      Definition: The date when this resource was created.

    • setCreated

      public ProcessRequest setCreated​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for created ()

      Definition: The date when this resource was created.

    • setCreatedWithSecondsPrecision

      public ProcessRequest setCreatedWithSecondsPrecision​(Date theDate)
      Sets the value for created ()

      Definition: The date when this resource was created.

    • getTarget

      public ResourceReferenceDt getTarget()
      Gets the value(s) for target (). creating it if it does not exist. Will not return null.

      Definition: The organization which is the target of the request.

    • setTarget

      public ProcessRequest setTarget​(ResourceReferenceDt theValue)
      Sets the value(s) for target ()

      Definition: The organization which is the target of the request.

    • getProvider

      public ResourceReferenceDt getProvider()
      Gets the value(s) for provider (). creating it if it does not exist. Will not return null.

      Definition: The practitioner who is responsible for the action specified in thise request.

    • setProvider

      public ProcessRequest setProvider​(ResourceReferenceDt theValue)
      Sets the value(s) for provider ()

      Definition: The practitioner who is responsible for the action specified in thise request.

    • getOrganization

      public ResourceReferenceDt getOrganization()
      Gets the value(s) for organization (). creating it if it does not exist. Will not return null.

      Definition: The organization which is responsible for the action speccified in thise request.

    • setOrganization

      public ProcessRequest setOrganization​(ResourceReferenceDt theValue)
      Sets the value(s) for organization ()

      Definition: The organization which is responsible for the action speccified in thise request.

    • getRequest

      public ResourceReferenceDt getRequest()
      Gets the value(s) for request (). creating it if it does not exist. Will not return null.

      Definition: Reference of resource which is the target or subject of this action.

    • setRequest

      public ProcessRequest setRequest​(ResourceReferenceDt theValue)
      Sets the value(s) for request ()

      Definition: Reference of resource which is the target or subject of this action.

    • getResponse

      public ResourceReferenceDt getResponse()
      Gets the value(s) for response (). creating it if it does not exist. Will not return null.

      Definition: Reference of a prior response to resource which is the target or subject of this action.

    • setResponse

      public ProcessRequest setResponse​(ResourceReferenceDt theValue)
      Sets the value(s) for response ()

      Definition: Reference of a prior response to resource which is the target or subject of this action.

    • getNullifyElement

      public ca.uhn.fhir.model.primitive.BooleanDt getNullifyElement()
      Gets the value(s) for nullify (). creating it if it does not exist. Will not return null.

      Definition: If true remove all history excluding audit.

    • getNullify

      public Boolean getNullify()
      Gets the value(s) for nullify (). creating it if it does not exist. This method may return null.

      Definition: If true remove all history excluding audit.

    • setNullify

      public ProcessRequest setNullify​(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for nullify ()

      Definition: If true remove all history excluding audit.

    • setNullify

      public ProcessRequest setNullify​(boolean theBoolean)
      Sets the value for nullify ()

      Definition: If true remove all history excluding audit.

    • getReferenceElement

      public ca.uhn.fhir.model.primitive.StringDt getReferenceElement()
      Gets the value(s) for reference (). creating it if it does not exist. Will not return null.

      Definition: A reference to supply which authenticates the process.

    • getReference

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

      Definition: A reference to supply which authenticates the process.

    • setReference

      public ProcessRequest setReference​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Sets the value(s) for reference ()

      Definition: A reference to supply which authenticates the process.

    • setReference

      public ProcessRequest setReference​(String theString)
      Sets the value for reference ()

      Definition: A reference to supply which authenticates the process.

    • getItem

      public List<ProcessRequest.Item> getItem()
      Gets the value(s) for item (). creating it if it does not exist. Will not return null.

      Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.

    • setItem

      public ProcessRequest setItem​(List<ProcessRequest.Item> theValue)
      Sets the value(s) for item ()

      Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.

    • addItem

      public ProcessRequest.Item addItem()
      Adds and returns a new value for item ()

      Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.

    • addItem

      public ProcessRequest addItem​(ProcessRequest.Item theValue)
      Adds a given new value for item ()

      Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.

      Parameters:
      theValue - The item to add (must not be null)

    • getItemFirstRep

      public ProcessRequest.Item getItemFirstRep()
      Gets the first repetition for item (), creating it if it does not already exist.

      Definition: List of top level items to be re-adjudicated, if none specified then the entire submission is re-adjudicated.

    • getInclude

      public List<ca.uhn.fhir.model.primitive.StringDt> getInclude()
      Gets the value(s) for include (). creating it if it does not exist. Will not return null.

      Definition: Names of resource types to include

    • setInclude

      public ProcessRequest setInclude​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
      Sets the value(s) for include ()

      Definition: Names of resource types to include

    • addInclude

      public ca.uhn.fhir.model.primitive.StringDt addInclude()
      Adds and returns a new value for include ()

      Definition: Names of resource types to include

    • addInclude

      public ProcessRequest addInclude​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Adds a given new value for include ()

      Definition: Names of resource types to include

      Parameters:
      theValue - The include to add (must not be null)

    • getIncludeFirstRep

      public ca.uhn.fhir.model.primitive.StringDt getIncludeFirstRep()
      Gets the first repetition for include (), creating it if it does not already exist.

      Definition: Names of resource types to include

    • addInclude

      public ProcessRequest addInclude​(String theString)
      Adds a new value for include ()

      Definition: Names of resource types to include

      Returns:
      Returns a reference to this object, to allow for simple chaining.

    • getExclude

      public List<ca.uhn.fhir.model.primitive.StringDt> getExclude()
      Gets the value(s) for exclude (). creating it if it does not exist. Will not return null.

      Definition: Names of resource types to exclude

    • setExclude

      public ProcessRequest setExclude​(List<ca.uhn.fhir.model.primitive.StringDt> theValue)
      Sets the value(s) for exclude ()

      Definition: Names of resource types to exclude

    • addExclude

      public ca.uhn.fhir.model.primitive.StringDt addExclude()
      Adds and returns a new value for exclude ()

      Definition: Names of resource types to exclude

    • addExclude

      public ProcessRequest addExclude​(ca.uhn.fhir.model.primitive.StringDt theValue)
      Adds a given new value for exclude ()

      Definition: Names of resource types to exclude

      Parameters:
      theValue - The exclude to add (must not be null)

    • getExcludeFirstRep

      public ca.uhn.fhir.model.primitive.StringDt getExcludeFirstRep()
      Gets the first repetition for exclude (), creating it if it does not already exist.

      Definition: Names of resource types to exclude

    • addExclude

      public ProcessRequest addExclude​(String theString)
      Adds a new value for exclude ()

      Definition: Names of resource types to exclude

      Returns:
      Returns a reference to this object, to allow for simple chaining.

    • getPeriod

      public PeriodDt getPeriod()
      Gets the value(s) for period (). creating it if it does not exist. Will not return null.

      Definition: A period of time during which the fulfilling resources would have been created.

    • setPeriod

      public ProcessRequest setPeriod​(PeriodDt theValue)
      Sets the value(s) for period ()

      Definition: A period of time during which the fulfilling resources would have been created.

    • getResourceName

      public String 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