Class ProcedureRequest

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

    Definition: A request for a procedure to be performed. May be a proposal or an order.

    Requirements:

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

    See Also:
    Serialized Form
    • Field Detail

      • SP_IDENTIFIER

        public static final String SP_IDENTIFIER
        Search parameter constant for identifier

        Description: A unique identifier of the Procedure Request
        Type: token
        Path: ProcedureRequest.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: A unique identifier of the Procedure Request
        Type: token
        Path: ProcedureRequest.identifier

      • SP_SUBJECT

        public static final String SP_SUBJECT
        Search parameter constant for subject

        Description: Search by subject
        Type: reference
        Path: ProcedureRequest.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: Search by subject
        Type: reference
        Path: ProcedureRequest.subject

      • SP_PATIENT

        public static final String SP_PATIENT
        Search parameter constant for patient

        Description: Search by subject - a patient
        Type: reference
        Path: ProcedureRequest.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: Search by subject - a patient
        Type: reference
        Path: ProcedureRequest.subject

      • ORDERER

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

        Description:
        Type: reference
        Path: ProcedureRequest.orderer

      • PERFORMER

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

        Description:
        Type: reference
        Path: ProcedureRequest.performer

      • ENCOUNTER

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

        Description:
        Type: reference
        Path: ProcedureRequest.encounter

      • 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 "ProcedureRequest:encounter".
      • INCLUDE_ORDERER

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

        public static final ca.uhn.fhir.model.api.Include INCLUDE_PERFORMER
        Constant for fluent queries to be used to add include statements. Specifies the path value of "ProcedureRequest:performer".
      • 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 "ProcedureRequest:subject".
    • 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: Identifiers assigned to this order by the order or by the receiver.

      • addIdentifier

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

        Definition: Identifiers assigned to this order by the order or by the receiver.

      • addIdentifier

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

        Definition: Identifiers assigned to this order by the order or by the receiver.

        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: Identifiers assigned to this order by the order or by the receiver.

      • getSubject

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

        Definition: The person, animal or group that should receive the procedure.

      • getCode

        public CodeableConceptDt getCode()
        Gets the value(s) for code (class). creating it if it does not exist. Will not return null.

        Definition: The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded.

      • setCode

        public ProcedureRequest setCode​(CodeableConceptDt theValue)
        Sets the value(s) for code (class)

        Definition: The specific procedure that is ordered. Use text if the exact nature of the procedure cannot be coded.

      • getBodySite

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

        Definition: Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

      • setBodySite

        public ProcedureRequest setBodySite​(List<CodeableConceptDt> theValue)
        Sets the value(s) for bodySite ()

        Definition: Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

      • addBodySite

        public CodeableConceptDt addBodySite()
        Adds and returns a new value for bodySite ()

        Definition: Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

      • addBodySite

        public ProcedureRequest addBodySite​(CodeableConceptDt theValue)
        Adds a given new value for bodySite ()

        Definition: Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

        Parameters:
        theValue - The bodySite to add (must not be null)
      • getBodySiteFirstRep

        public CodeableConceptDt getBodySiteFirstRep()
        Gets the first repetition for bodySite (), creating it if it does not already exist.

        Definition: Indicates the sites on the subject's body where the procedure should be performed (I.e. the target sites).

      • getReason

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

        Definition: The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.

      • setReason

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

        Definition: The reason why the procedure is being proposed or ordered. This procedure request may be motivated by a Condition for instance.

      • getScheduled

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

        Definition: The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions. E.g. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".

      • setScheduled

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

        Definition: The timing schedule for the proposed or ordered procedure. The Schedule data type allows many different expressions. E.g. \"Every 8 hours\"; \"Three times a day\"; \"1/2 an hour before breakfast for 10 days from 23-Dec 2011:\"; \"15 Oct 2013, 17 Oct 2013 and 1 Nov 2013\".

      • getEncounter

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

        Definition: The encounter within which the procedure proposal or request was created.

      • getPerformer

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

        Definition: For example, the surgeon, anaethetist, endoscopist, etc.

      • getStatusElement

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

        Definition: The status of the order.

      • getStatus

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

        Definition: The status of the order.

      • getNotes

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

        Definition: Any other notes associated with this proposal or order - e.g. provider instructions.

      • setNotes

        public ProcedureRequest setNotes​(List<AnnotationDt> theValue)
        Sets the value(s) for notes ()

        Definition: Any other notes associated with this proposal or order - e.g. provider instructions.

      • addNotes

        public AnnotationDt addNotes()
        Adds and returns a new value for notes ()

        Definition: Any other notes associated with this proposal or order - e.g. provider instructions.

      • addNotes

        public ProcedureRequest addNotes​(AnnotationDt theValue)
        Adds a given new value for notes ()

        Definition: Any other notes associated with this proposal or order - e.g. provider instructions.

        Parameters:
        theValue - The notes to add (must not be null)
      • getNotesFirstRep

        public AnnotationDt getNotesFirstRep()
        Gets the first repetition for notes (), creating it if it does not already exist.

        Definition: Any other notes associated with this proposal or order - e.g. provider instructions.

      • getAsNeeded

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

        Definition: If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.

      • setAsNeeded

        public ProcedureRequest setAsNeeded​(ca.uhn.fhir.model.api.IDatatype theValue)
        Sets the value(s) for asNeeded[x] ()

        Definition: If a CodeableConcept is present, it indicates the pre-condition for performing the procedure.

      • getOrderedOnElement

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

        Definition: The time when the request was made.

      • getOrderedOn

        public Date getOrderedOn()
        Gets the value(s) for orderedOn (when.recorded). creating it if it does not exist. This method may return null.

        Definition: The time when the request was made.

      • setOrderedOn

        public ProcedureRequest setOrderedOn​(ca.uhn.fhir.model.primitive.DateTimeDt theValue)
        Sets the value(s) for orderedOn (when.recorded)

        Definition: The time when the request was made.

      • setOrderedOn

        public ProcedureRequest setOrderedOn​(Date theDate,
                                             ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        Sets the value for orderedOn (when.recorded)

        Definition: The time when the request was made.

      • getOrderer

        public ResourceReferenceDt getOrderer()
        Gets the value(s) for orderer (who.author). creating it if it does not exist. Will not return null.

        Definition: The healthcare professional responsible for proposing or ordering the procedure.

      • getPriorityElement

        public ca.uhn.fhir.model.primitive.BoundCodeDt<ProcedureRequestPriorityEnumgetPriorityElement()
        Gets the value(s) for priority (grade). creating it if it does not exist. Will not return null.

        Definition: The clinical priority associated with this order.

      • getPriority

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

        Definition: The clinical priority associated with this order.

      • 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