Class Order

  • 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 Order
    extends BaseResource
    implements ca.uhn.fhir.model.api.IResource
    HAPI/FHIR Order Resource (workflow.order)

    Definition: A request to perform an action.

    Requirements:

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

    See Also:
    Serialized Form
    • Field Detail

      • DATE

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

        Description:
        Type: date
        Path: Order.date

      • SUBJECT

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

        Description:
        Type: reference
        Path: Order.subject

      • SOURCE

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

        Description:
        Type: reference
        Path: Order.source

      • TARGET

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

        Description:
        Type: reference
        Path: Order.target

      • WHEN_CODE

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

        Description:
        Type: token
        Path: Order.when.code

      • WHEN

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

        Description:
        Type: date
        Path: Order.when.schedule

      • DETAIL

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

        Description:
        Type: reference
        Path: Order.detail

      • PATIENT

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

        Description:
        Type: reference
        Path: Order.subject

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: Instance id from source, target, and/or others
        Type: token
        Path: Order.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: Instance id from source, target, and/or others
        Type: token
        Path: Order.identifier

      • INCLUDE_DETAIL

        public static final ca.uhn.fhir.model.api.Include INCLUDE_DETAIL
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:detail".
      • 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 "Order:patient".
      • INCLUDE_SOURCE

        public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:source".
      • 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 "Order:subject".
      • INCLUDE_TARGET

        public static final ca.uhn.fhir.model.api.Include INCLUDE_TARGET
        Constant for fluent queries to be used to add include statements. Specifies the path value of "Order:target".
    • Constructor Detail

    • Method Detail

      • 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

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

        Definition:

      • addIdentifier

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

        Definition:

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

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

        Definition:

      • getDateElement

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

        Definition:

      • getDate

        public Date getDate()
        Gets the value(s) for date (when.done). creating it if it does not exist. This method may return null.

        Definition:

      • setDate

        public Order setDate​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for date (when.done)

        Definition:

      • setDate

        public Order setDate​(Date theDate,
                             ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for date (when.done)

        Definition:

      • getSubject

        public ResourceReferenceDt getSubject()
        Gets the value(s) for subject (who.focus). creating it if it does not exist. Will not return null.

        Definition:

      • getSource

        public ResourceReferenceDt getSource()
        Gets the value(s) for source (who.cause). creating it if it does not exist. Will not return null.

        Definition:

      • getTarget

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

        Definition:

      • getReason

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

        Definition:

      • setReason

        public Order setReason​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for reason[x] (why)

        Definition:

      • getWhen

        public Order.When getWhen()
        Gets the value(s) for when (). creating it if it does not exist. Will not return null.

        Definition:

      • 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