Procedure (HAPI FHIR - Core Library 0.7 API)

java.lang.Object
- ca.uhn.fhir.model.api.BaseElement
- - ca.uhn.fhir.model.api.BaseResource
  - - ca.uhn.fhir.model.dstu.resource.Procedure

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions
```
public class Procedure
extends BaseResource
implements IResource
```
HAPI/FHIR Procedure Resource (An action that is performed on a patient)
Definition: An action that is performed on a patient. This can be a physical 'thing' like an operation, or less invasive like counseling or hypnotherapy

Requirements:

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Procedure.Performer` Block class for child element: Procedure.performer (The people who performed the procedure)
`static class`	`Procedure.RelatedItem` Block class for child element: Procedure.relatedItem (A procedure that is related to this one)

Field Summary

Fields
Modifier and Type	Field and Description
`static DateClientParam`	`DATE` Fluent Client search parameter constant for date
`static Include`	`INCLUDE_SUBJECT` Constant for fluent queries to be used to add include statements.
`static String`	`SP_DATE` Search parameter constant for date
`static String`	`SP_SUBJECT` Search parameter constant for subject
`static String`	`SP_TYPE` Search parameter constant for type
`static ReferenceClientParam`	`SUBJECT` Fluent Client search parameter constant for subject
`static TokenClientParam`	`TYPE` Fluent Client search parameter constant for type

Fields inherited from class ca.uhn.fhir.model.api.BaseResource
SP_RES_ID, SP_RES_LANGUAGE

Constructor Summary

Constructors
Constructor and Description

Procedure()

Constructors
Constructor and Description
`Procedure()`

Method Summary

Methods
Modifier and Type	Method and Description
`CodeableConceptDt`	`addBodySite()` Adds and returns a new value for bodySite (Precise location details)
`CodeableConceptDt`	`addComplication()` Adds and returns a new value for complication (Complication following the procedure)
`IdentifierDt`	`addIdentifier()` Adds and returns a new value for identifier (External Ids for this procedure)
`Procedure`	`addIdentifier(IdentifierUseEnum theUse, String theSystem, String theValue, String theLabel)` Adds a new value for identifier (External Ids for this procedure)
`Procedure`	`addIdentifier(String theSystem, String theValue)` Adds a new value for identifier (External Ids for this procedure)
`CodeableConceptDt`	`addIndication()` Adds and returns a new value for indication (Reason procedure performed)
`Procedure.Performer`	`addPerformer()` Adds and returns a new value for performer (The people who performed the procedure)
`Procedure.RelatedItem`	`addRelatedItem()` Adds and returns a new value for relatedItem (A procedure that is related to this one)
`ResourceReferenceDt`	`addReport()` Adds and returns a new value for report (Any report that results from the procedure)
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)` Returns a list containing all child elements matching a given type
`List<CodeableConceptDt>`	`getBodySite()` Gets the value(s) for bodySite (Precise location details).
`CodeableConceptDt`	`getBodySiteFirstRep()` Gets the first repetition for bodySite (Precise location details), creating it if it does not already exist.
`List<CodeableConceptDt>`	`getComplication()` Gets the value(s) for complication (Complication following the procedure).
`CodeableConceptDt`	`getComplicationFirstRep()` Gets the first repetition for complication (Complication following the procedure), creating it if it does not already exist.
`PeriodDt`	`getDate()` Gets the value(s) for date (The date the procedure was performed).
`ResourceReferenceDt`	`getEncounter()` Gets the value(s) for encounter (The encounter when procedure performed).
`StringDt`	`getFollowUp()` Gets the value(s) for followUp (Instructions for follow up).
`List<IdentifierDt>`	`getIdentifier()` Gets the value(s) for identifier (External Ids for this procedure).
`IdentifierDt`	`getIdentifierFirstRep()` Gets the first repetition for identifier (External Ids for this procedure), creating it if it does not already exist.
`List<CodeableConceptDt>`	`getIndication()` Gets the value(s) for indication (Reason procedure performed).
`CodeableConceptDt`	`getIndicationFirstRep()` Gets the first repetition for indication (Reason procedure performed), creating it if it does not already exist.
`StringDt`	`getNotes()` Gets the value(s) for notes (Additional information about procedure).
`StringDt`	`getOutcome()` Gets the value(s) for outcome (What was result of procedure?).
`List<Procedure.Performer>`	`getPerformer()` Gets the value(s) for performer (The people who performed the procedure).
`Procedure.Performer`	`getPerformerFirstRep()` Gets the first repetition for performer (The people who performed the procedure), creating it if it does not already exist.
`List<Procedure.RelatedItem>`	`getRelatedItem()` Gets the value(s) for relatedItem (A procedure that is related to this one).
`Procedure.RelatedItem`	`getRelatedItemFirstRep()` Gets the first repetition for relatedItem (A procedure that is related to this one), creating it if it does not already exist.
`List<ResourceReferenceDt>`	`getReport()` Gets the value(s) for report (Any report that results from the procedure).
`ResourceReferenceDt`	`getSubject()` Gets the value(s) for subject (Who procedure was performed on).
`CodeableConceptDt`	`getType()` Gets the value(s) for type (Identification of the procedure).
`boolean`	`isEmpty()`
`Procedure`	`setBodySite(List<CodeableConceptDt> theValue)` Sets the value(s) for bodySite (Precise location details)
`Procedure`	`setComplication(List<CodeableConceptDt> theValue)` Sets the value(s) for complication (Complication following the procedure)
`Procedure`	`setDate(PeriodDt theValue)` Sets the value(s) for date (The date the procedure was performed)
`Procedure`	`setEncounter(ResourceReferenceDt theValue)` Sets the value(s) for encounter (The encounter when procedure performed)
`Procedure`	`setFollowUp(String theString)` Sets the value for followUp (Instructions for follow up)
`Procedure`	`setFollowUp(StringDt theValue)` Sets the value(s) for followUp (Instructions for follow up)
`Procedure`	`setIdentifier(List<IdentifierDt> theValue)` Sets the value(s) for identifier (External Ids for this procedure)
`Procedure`	`setIndication(List<CodeableConceptDt> theValue)` Sets the value(s) for indication (Reason procedure performed)
`Procedure`	`setNotes(String theString)` Sets the value for notes (Additional information about procedure)
`Procedure`	`setNotes(StringDt theValue)` Sets the value(s) for notes (Additional information about procedure)
`Procedure`	`setOutcome(String theString)` Sets the value for outcome (What was result of procedure?)
`Procedure`	`setOutcome(StringDt theValue)` Sets the value(s) for outcome (What was result of procedure?)
`Procedure`	`setPerformer(List<Procedure.Performer> theValue)` Sets the value(s) for performer (The people who performed the procedure)
`Procedure`	`setRelatedItem(List<Procedure.RelatedItem> theValue)` Sets the value(s) for relatedItem (A procedure that is related to this one)
`Procedure`	`setReport(List<ResourceReferenceDt> theValue)` Sets the value(s) for report (Any report that results from the procedure)
`Procedure`	`setSubject(ResourceReferenceDt theValue)` Sets the value(s) for subject (Who procedure was performed on)
`Procedure`	`setType(CodeableConceptDt theValue)` Sets the value(s) for type (Identification of the procedure)

Methods inherited from class ca.uhn.fhir.model.api.BaseResource
getContained, getId, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement
addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource
getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

- Field Detail
  - SP_TYPE
```
public static final String SP_TYPE
```
    Search parameter constant for type
    Description: Type of procedure
    Type: token
    Path: Procedure.type
    
    See Also:
    Constant Field Values
  - TYPE
```
public static final TokenClientParam TYPE
```
    Fluent Client search parameter constant for type
    Description: Type of procedure
    Type: token
    Path: Procedure.type
  - SP_SUBJECT
```
public static final String SP_SUBJECT
```
    Search parameter constant for subject
    Description: The identity of a patient to list procedures for
    Type: reference
    Path: Procedure.subject
    
    See Also:
    Constant Field Values
  - SUBJECT
```
public static final ReferenceClientParam SUBJECT
```
    Fluent Client search parameter constant for subject
    Description: The identity of a patient to list procedures for
    Type: reference
    Path: Procedure.subject
  - INCLUDE_SUBJECT
```
public static final Include INCLUDE_SUBJECT
```
    Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure.subject".
  - SP_DATE
```
public static final String SP_DATE
```
    Search parameter constant for date
    Description: The date the procedure was performed on
    Type: date
    Path: Procedure.date
    
    See Also:
    Constant Field Values
  - DATE
```
public static final DateClientParam DATE
```
    Fluent Client search parameter constant for date
    Description: The date the procedure was performed on
    Type: date
    Path: Procedure.date
- Constructor Detail
  - Procedure
```
public Procedure()
```
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IElement
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Description copied from interface: ICompositeElement
    
    Returns a list containing all child elements matching a given type
    
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface ICompositeElement
    
    Parameters:
    theType - The type to match. If set to null, all child elements will be returned
  - getIdentifier
```
public List<IdentifierDt> getIdentifier()
```
    Gets the value(s) for identifier (External Ids for this procedure). creating it if it does not exist. Will not return null.
    Definition: This records identifiers associated with this procedure that are defined by business processed 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 (External Ids for this procedure)
    Definition: This records identifiers associated with this procedure that are defined by business processed 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 IdentifierDt addIdentifier()
```
    Adds and returns a new value for identifier (External Ids for this procedure)
    Definition: This records identifiers associated with this procedure that are defined by business processed 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)
  - getIdentifierFirstRep
```
public IdentifierDt getIdentifierFirstRep()
```
    Gets the first repetition for identifier (External Ids for this procedure), creating it if it does not already exist.
    Definition: This records identifiers associated with this procedure that are defined by business processed 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(IdentifierUseEnum theUse,
                      String theSystem,
                      String theValue,
                      String theLabel)
```
    Adds a new value for identifier (External Ids for this procedure)
    Definition: This records identifiers associated with this procedure that are defined by business processed 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)
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - addIdentifier
```
public Procedure addIdentifier(String theSystem,
                      String theValue)
```
    Adds a new value for identifier (External Ids for this procedure)
    Definition: This records identifiers associated with this procedure that are defined by business processed 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)
    
    Returns:
    Returns a reference to this object, to allow for simple chaining.
  - getSubject
```
public ResourceReferenceDt getSubject()
```
    Gets the value(s) for subject (Who procedure was performed on). creating it if it does not exist. Will not return null.
    Definition: The person on whom the procedure was performed
  - setSubject
```
public Procedure setSubject(ResourceReferenceDt theValue)
```
    Sets the value(s) for subject (Who procedure was performed on)
    Definition: The person on whom the procedure was performed
  - getType
```
public CodeableConceptDt getType()
```
    Gets the value(s) for type (Identification of the procedure). 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 can't be coded
  - setType
```
public Procedure setType(CodeableConceptDt theValue)
```
    Sets the value(s) for type (Identification of the procedure)
    Definition: The specific procedure that is performed. Use text if the exact nature of the procedure can't be coded
  - getBodySite
```
public List<CodeableConceptDt> getBodySite()
```
    Gets the value(s) for bodySite (Precise location details). 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
```
public Procedure setBodySite(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for bodySite (Precise location details)
    Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion
  - addBodySite
```
public CodeableConceptDt addBodySite()
```
    Adds and returns a new value for bodySite (Precise location details)
    Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion
  - getBodySiteFirstRep
```
public CodeableConceptDt getBodySiteFirstRep()
```
    Gets the first repetition for bodySite (Precise location details), 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
  - getIndication
```
public List<CodeableConceptDt> getIndication()
```
    Gets the value(s) for indication (Reason procedure performed). 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
  - setIndication
```
public Procedure setIndication(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for indication (Reason procedure performed)
    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
  - addIndication
```
public CodeableConceptDt addIndication()
```
    Adds and returns a new value for indication (Reason procedure performed)
    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
  - getIndicationFirstRep
```
public CodeableConceptDt getIndicationFirstRep()
```
    Gets the first repetition for indication (Reason procedure performed), creating it if it does not already exist.
    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
```
public List<Procedure.Performer> getPerformer()
```
    Gets the value(s) for performer (The people who performed the procedure). creating it if it does not exist. Will not return null.
    Definition: Limited to 'real' people rather than equipment
  - setPerformer
```
public Procedure setPerformer(List<Procedure.Performer> theValue)
```
    Sets the value(s) for performer (The people who performed the procedure)
    Definition: Limited to 'real' people rather than equipment
  - addPerformer
```
public Procedure.Performer addPerformer()
```
    Adds and returns a new value for performer (The people who performed the procedure)
    Definition: Limited to 'real' people rather than equipment
  - getPerformerFirstRep
```
public Procedure.Performer getPerformerFirstRep()
```
    Gets the first repetition for performer (The people who performed the procedure), creating it if it does not already exist.
    Definition: Limited to 'real' people rather than equipment
  - getDate
```
public PeriodDt getDate()
```
    Gets the value(s) for date (The date the procedure was performed). creating it if it does not exist. Will not return null.
    Definition: The dates over which the procedure was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured.
  - setDate
```
public Procedure setDate(PeriodDt theValue)
```
    Sets the value(s) for date (The date the procedure was performed)
    Definition: The dates over which the procedure was performed. Allows a period to support complex procedures that span more that one date, and also allows for the length of the procedure to be captured.
  - getEncounter
```
public ResourceReferenceDt getEncounter()
```
    Gets the value(s) for encounter (The encounter when procedure performed). creating it if it does not exist. Will not return null.
    Definition: The encounter during which the procedure was performed
  - setEncounter
```
public Procedure setEncounter(ResourceReferenceDt theValue)
```
    Sets the value(s) for encounter (The encounter when procedure performed)
    Definition: The encounter during which the procedure was performed
  - getOutcome
```
public StringDt getOutcome()
```
    Gets the value(s) for outcome (What was result of procedure?). creating it if it does not exist. Will not return null.
    Definition: What was the outcome of the procedure - did it resolve reasons why the procedure was performed?
  - setOutcome
```
public Procedure setOutcome(StringDt theValue)
```
    Sets the value(s) for outcome (What was result of procedure?)
    Definition: What was the outcome of the procedure - did it resolve reasons why the procedure was performed?
  - setOutcome
```
public Procedure setOutcome(String theString)
```
    Sets the value for outcome (What was result of procedure?)
    Definition: What was the outcome of the procedure - did it resolve reasons why the procedure was performed?
  - getReport
```
public List<ResourceReferenceDt> getReport()
```
    Gets the value(s) for report (Any report that results from the procedure). creating it if it does not exist. Will not return null.
    Definition: This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies
  - setReport
```
public Procedure setReport(List<ResourceReferenceDt> theValue)
```
    Sets the value(s) for report (Any report that results from the procedure)
    Definition: This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies
  - addReport
```
public ResourceReferenceDt addReport()
```
    Adds and returns a new value for report (Any report that results from the procedure)
    Definition: This could be a histology result. There could potentially be multiple reports - e.g. if this was a procedure that made multiple biopsies
  - getComplication
```
public List<CodeableConceptDt> getComplication()
```
    Gets the value(s) for complication (Complication following the procedure). creating it if it does not exist. Will not return null.
    Definition: Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues
  - setComplication
```
public Procedure setComplication(List<CodeableConceptDt> theValue)
```
    Sets the value(s) for complication (Complication following the procedure)
    Definition: Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues
  - addComplication
```
public CodeableConceptDt addComplication()
```
    Adds and returns a new value for complication (Complication following the procedure)
    Definition: Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues
  - getComplicationFirstRep
```
public CodeableConceptDt getComplicationFirstRep()
```
    Gets the first repetition for complication (Complication following the procedure), creating it if it does not already exist.
    Definition: Any complications that occurred during the procedure, or in the immediate post-operative period. These are generally tracked separately from the notes, which typically will describe the procedure itself rather than any 'post procedure' issues
  - getFollowUp
```
public StringDt getFollowUp()
```
    Gets the value(s) for followUp (Instructions for follow up). 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 potentially could be more complex in which case the CarePlan resource can be used
  - setFollowUp
```
public Procedure setFollowUp(StringDt theValue)
```
    Sets the value(s) for followUp (Instructions for follow up)
    Definition: If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used
  - setFollowUp
```
public Procedure setFollowUp(String theString)
```
    Sets the value for followUp (Instructions for follow up)
    Definition: If the procedure required specific follow up - e.g. removal of sutures. The followup may be represented as a simple note, or potentially could be more complex in which case the CarePlan resource can be used
  - getRelatedItem
```
public List<Procedure.RelatedItem> getRelatedItem()
```
    Gets the value(s) for relatedItem (A procedure that is related to this one). creating it if it does not exist. Will not return null.
    Definition: Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure
  - setRelatedItem
```
public Procedure setRelatedItem(List<Procedure.RelatedItem> theValue)
```
    Sets the value(s) for relatedItem (A procedure that is related to this one)
    Definition: Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure
  - addRelatedItem
```
public Procedure.RelatedItem addRelatedItem()
```
    Adds and returns a new value for relatedItem (A procedure that is related to this one)
    Definition: Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure
  - getRelatedItemFirstRep
```
public Procedure.RelatedItem getRelatedItemFirstRep()
```
    Gets the first repetition for relatedItem (A procedure that is related to this one), creating it if it does not already exist.
    Definition: Procedures may be related to other items such as procedures or medications. For example treating wound dehiscence following a previous procedure
  - getNotes
```
public StringDt getNotes()
```
    Gets the value(s) for notes (Additional information about procedure). 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(StringDt theValue)
```
    Sets the value(s) for notes (Additional information about procedure)
    Definition: Any other notes about the procedure - e.g. the operative notes
  - setNotes
```
public Procedure setNotes(String theString)
```
    Sets the value for notes (Additional information about procedure)
    Definition: Any other notes about the procedure - e.g. the operative notes

Class Procedure

Nested Class Summary

Field Summary

Fields inherited from class ca.uhn.fhir.model.api.BaseResource

Constructor Summary

Method Summary

Methods inherited from class ca.uhn.fhir.model.api.BaseResource

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

Methods inherited from class java.lang.Object

Methods inherited from interface ca.uhn.fhir.model.api.IResource

Field Detail

SP_TYPE

TYPE

SP_SUBJECT

SUBJECT

INCLUDE_SUBJECT

SP_DATE

DATE

Constructor Detail

Procedure

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getIdentifier

setIdentifier

addIdentifier

getIdentifierFirstRep

addIdentifier

addIdentifier

getSubject

setSubject

getType

setType

getBodySite

setBodySite

addBodySite

getBodySiteFirstRep

getIndication

setIndication

addIndication

getIndicationFirstRep

getPerformer

setPerformer

addPerformer

getPerformerFirstRep

getDate

setDate

getEncounter

setEncounter

getOutcome

setOutcome

setOutcome

getReport

setReport

addReport

getComplication

setComplication

addComplication

getComplicationFirstRep

getFollowUp

setFollowUp

setFollowUp

getRelatedItem

setRelatedItem

addRelatedItem

getRelatedItemFirstRep

getNotes

setNotes

setNotes