Class Procedure

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

Definition: An action that is or was performed on a patient. This can be a physical intervention like an operation, or less invasive like counseling or hypnotherapy.

Requirements:

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

See Also:
Serialized Form
  • Field Details

    • SP_CODE

      public static final String SP_CODE
      Search parameter constant for code

      Description: A code to identify a procedure
      Type: token
      Path: Procedure.code

      See Also:
      Constant Field Values
    • CODE

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

      Description: A code to identify a procedure
      Type: token
      Path: Procedure.code

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter constant for identifier

      Description: A unique identifier for a procedure
      Type: token
      Path: Procedure.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 for a procedure
      Type: token
      Path: Procedure.identifier

    • SP_DATE

      public static final String SP_DATE
      Search parameter constant for date

      Description:
      Type: date
      Path: Procedure.performed[x]

      See Also:
      Constant Field Values
    • DATE

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

      Description:
      Type: date
      Path: Procedure.performed[x]

    • SP_PERFORMER

      public static final String SP_PERFORMER
      Search parameter constant for performer

      Description:
      Type: reference
      Path: Procedure.performer.actor

      See Also:
      Constant Field Values
    • PERFORMER

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

      Description:
      Type: reference
      Path: Procedure.performer.actor

    • SP_LOCATION

      public static final String SP_LOCATION
      Search parameter constant for location

      Description:
      Type: reference
      Path: Procedure.location

      See Also:
      Constant Field Values
    • LOCATION

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

      Description:
      Type: reference
      Path: Procedure.location

    • SP_ENCOUNTER

      public static final String SP_ENCOUNTER
      Search parameter constant for encounter

      Description:
      Type: reference
      Path: Procedure.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: Procedure.encounter

    • SP_SUBJECT

      public static final String SP_SUBJECT
      Search parameter constant for subject

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

    • SP_PATIENT

      public static final String SP_PATIENT
      Search parameter constant for patient

      Description: Search by subject - a patient
      Type: reference
      Path: Procedure.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: Procedure.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 "Procedure:encounter".
    • INCLUDE_LOCATION

      public static final ca.uhn.fhir.model.api.Include INCLUDE_LOCATION
      Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:location".
    • 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 "Procedure: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 "Procedure: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 "Procedure: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 (id). creating it if it does not exist. Will not return null.

      Definition: This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

    • setIdentifier

      public Procedure setIdentifier(List<IdentifierDt> theValue)
      Sets the value(s) for identifier (id)

      Definition: This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

    • addIdentifier

      Adds and returns a new value for identifier (id)

      Definition: This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

    • addIdentifier

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

      Definition: This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

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

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

      Definition: This records identifiers associated with this procedure that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation)

    • 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 on which the procedure was performed

    • setSubject

      Sets the value(s) for subject (who.focus)

      Definition: The person, animal or group on which the procedure was performed

    • getStatusElement

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

      Definition: A code specifying the state of the procedure. Generally this will be in-progress or completed state.

    • getStatus

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

      Definition: A code specifying the state of the procedure. Generally this will be in-progress or completed state.

    • setStatus

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

      Definition: A code specifying the state of the procedure. Generally this will be in-progress or completed state.

    • setStatus

      public Procedure setStatus(ProcedureStatusEnum theValue)
      Sets the value(s) for status ()

      Definition: A code specifying the state of the procedure. Generally this will be in-progress or completed state.

    • getCategory

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

      Definition: A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\")

    • setCategory

      public Procedure setCategory(CodeableConceptDt theValue)
      Sets the value(s) for category ()

      Definition: A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\")

    • 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 performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\")

    • setCode

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

      Definition: The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\")

    • getNotPerformedElement

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

      Definition: Set this to true if the record is saying that the procedure was NOT performed

    • getNotPerformed

      Gets the value(s) for notPerformed (). creating it if it does not exist. This method may return null.

      Definition: Set this to true if the record is saying that the procedure was NOT performed

    • setNotPerformed

      public Procedure setNotPerformed(ca.uhn.fhir.model.primitive.BooleanDt theValue)
      Sets the value(s) for notPerformed ()

      Definition: Set this to true if the record is saying that the procedure was NOT performed

    • setNotPerformed

      public Procedure setNotPerformed(boolean theBoolean)
      Sets the value for notPerformed ()

      Definition: Set this to true if the record is saying that the procedure was NOT performed

    • getReasonNotPerformed

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

      Definition: A code indicating why the procedure was not performed.

    • setReasonNotPerformed

      Sets the value(s) for reasonNotPerformed ()

      Definition: A code indicating why the procedure was not performed.

    • addReasonNotPerformed

      Adds and returns a new value for reasonNotPerformed ()

      Definition: A code indicating why the procedure was not performed.

    • addReasonNotPerformed

      Adds a given new value for reasonNotPerformed ()

      Definition: A code indicating why the procedure was not performed.

      Parameters:
      theValue - The reasonNotPerformed to add (must not be null)
    • getReasonNotPerformedFirstRep

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

      Definition: A code indicating why the procedure was not performed.

    • getBodySite

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

      Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion

    • setBodySite

      Sets the value(s) for bodySite ()

      Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion

    • addBodySite

      Adds and returns a new value for bodySite ()

      Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion

    • addBodySite

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

      Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion

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

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

      Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion

    • 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 was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text

    • setReason

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

      Definition: The reason why the procedure was performed. This may be due to a Condition, may be coded entity of some type, or may simply be present as text

    • getPerformer

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

      Definition: Limited to 'real' people rather than equipment

    • setPerformer

      Sets the value(s) for performer ()

      Definition: Limited to 'real' people rather than equipment

    • addPerformer

      Adds and returns a new value for performer ()

      Definition: Limited to 'real' people rather than equipment

    • addPerformer

      Adds a given new value for performer ()

      Definition: Limited to 'real' people rather than equipment

      Parameters:
      theValue - The performer to add (must not be null)
    • getPerformerFirstRep

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

      Definition: Limited to 'real' people rather than equipment

    • getPerformed

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

      Definition: The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

    • setPerformed

      public Procedure setPerformed(ca.uhn.fhir.model.api.IDatatype theValue)
      Sets the value(s) for performed[x] (when.done)

      Definition: The date(time)/period over which the procedure was performed. Allows a period to support complex procedures that span more than one date, and also allows for the length of the procedure to be captured.

    • getEncounter

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

      Definition: The encounter during which the procedure was performed

    • setEncounter

      Sets the value(s) for encounter (context)

      Definition: The encounter during which the procedure was performed

    • getLocation

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

      Definition: The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant

    • setLocation

      Sets the value(s) for location (where)

      Definition: The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant

    • getOutcome

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

      Definition: The outcome of the procedure - did it resolve reasons for the procedure being performed?

    • setOutcome

      public Procedure setOutcome(CodeableConceptDt theValue)
      Sets the value(s) for outcome ()

      Definition: The outcome of the procedure - did it resolve reasons for the procedure being performed?

    • getReport

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

      Definition: This could be a histology result, pathology report, surgical report, etc..

    • setReport

      Sets the value(s) for report ()

      Definition: This could be a histology result, pathology report, surgical report, etc..

    • addReport

      Adds and returns a new value for report ()

      Definition: This could be a histology result, pathology report, surgical report, etc..

    • getComplication

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

      Definition: Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues

    • setComplication

      Sets the value(s) for complication ()

      Definition: Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues

    • addComplication

      Adds and returns a new value for complication ()

      Definition: Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues

    • addComplication

      Adds a given new value for complication ()

      Definition: Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues

      Parameters:
      theValue - The complication to add (must not be null)
    • getComplicationFirstRep

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

      Definition: Any complications that occurred during the procedure, or in the immediate post-performance period. These are generally tracked separately from the notes, which will typically describe the procedure itself rather than any 'post procedure' issues

    • getFollowUp

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

      Definition: If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used

    • setFollowUp

      Sets the value(s) for followUp ()

      Definition: If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used

    • addFollowUp

      Adds and returns a new value for followUp ()

      Definition: If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used

    • addFollowUp

      public Procedure addFollowUp(CodeableConceptDt theValue)
      Adds a given new value for followUp ()

      Definition: If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used

      Parameters:
      theValue - The followUp to add (must not be null)
    • getFollowUpFirstRep

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

      Definition: If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or could potentially be more complex in which case the CarePlan resource can be used

    • getRequest

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

      Definition: A reference to a resource that contains details of the request for this procedure.

    • setRequest

      Sets the value(s) for request ()

      Definition: A reference to a resource that contains details of the request for this procedure.

    • getNotes

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

      Definition: Any other notes about the procedure. E.g. the operative notes

    • setNotes

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

      Definition: Any other notes about the procedure. E.g. the operative notes

    • addNotes

      Adds and returns a new value for notes ()

      Definition: Any other notes about the procedure. E.g. the operative notes

    • addNotes

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

      Definition: Any other notes about the procedure. E.g. the operative notes

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

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

      Definition: Any other notes about the procedure. E.g. the operative notes

    • getFocalDevice

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

      Definition: A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

    • setFocalDevice

      Sets the value(s) for focalDevice ()

      Definition: A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

    • addFocalDevice

      Adds and returns a new value for focalDevice ()

      Definition: A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

    • addFocalDevice

      Adds a given new value for focalDevice ()

      Definition: A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

      Parameters:
      theValue - The focalDevice to add (must not be null)
    • getFocalDeviceFirstRep

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

      Definition: A device that is implanted, removed or otherwise manipulated (calibration, battery replacement, fitting a prosthesis, attaching a wound-vac, etc.) as a focal portion of the Procedure.

    • getUsed

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

      Definition: Identifies medications, devices and any other substance used as part of the procedure

    • setUsed

      public Procedure setUsed(List<ResourceReferenceDt> theValue)
      Sets the value(s) for used ()

      Definition: Identifies medications, devices and any other substance used as part of the procedure

    • addUsed

      Adds and returns a new value for used ()

      Definition: Identifies medications, devices and any other substance used as part of the procedure

    • 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