public class Procedure extends BaseResource implements IResource
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
| Modifier and Type | Class and Description |
|---|---|
static class |
Procedure.FocalDevice
Block class for child element: Procedure.focalDevice ()
|
static class |
Procedure.Performer
Block class for child element: Procedure.performer ()
|
| Modifier and Type | Field and Description |
|---|---|
static TokenClientParam |
CODE
Fluent Client search parameter constant for code
|
static DateClientParam |
DATE
Fluent Client search parameter constant for date
|
static ReferenceClientParam |
ENCOUNTER
Fluent Client search parameter constant for encounter
|
static TokenClientParam |
IDENTIFIER
Fluent Client search parameter constant for identifier
|
static Include |
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements.
|
static Include |
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.
|
static ReferenceClientParam |
LOCATION
Fluent Client search parameter constant for location
|
static ReferenceClientParam |
PATIENT
Fluent Client search parameter constant for patient
|
static ReferenceClientParam |
PERFORMER
Fluent Client search parameter constant for performer
|
static String |
SP_CODE
Search parameter constant for code
|
static String |
SP_DATE
Search parameter constant for date
|
static String |
SP_ENCOUNTER
Search parameter constant for encounter
|
static String |
SP_IDENTIFIER
Search parameter constant for identifier
|
static String |
SP_LOCATION
Search parameter constant for location
|
static String |
SP_PATIENT
Search parameter constant for patient
|
static String |
SP_PERFORMER
Search parameter constant for performer
|
static String |
SP_SUBJECT
Search parameter constant for subject
|
static ReferenceClientParam |
SUBJECT
Fluent Client search parameter constant for subject
|
RES_ID, SP_RES_ID, SP_RES_LANGUAGEINCLUDE_ALL, WILDCARD_ALL_SET| Constructor and Description |
|---|
Procedure() |
| Modifier and Type | Method and Description |
|---|---|
CodeableConceptDt |
addBodySite()
Adds and returns a new value for bodySite ()
|
Procedure |
addBodySite(CodeableConceptDt theValue)
Adds a given new value for bodySite ()
|
CodeableConceptDt |
addComplication()
Adds and returns a new value for complication ()
|
Procedure |
addComplication(CodeableConceptDt theValue)
Adds a given new value for complication ()
|
Procedure.FocalDevice |
addFocalDevice()
Adds and returns a new value for focalDevice ()
|
Procedure |
addFocalDevice(Procedure.FocalDevice theValue)
Adds a given new value for focalDevice ()
|
CodeableConceptDt |
addFollowUp()
Adds and returns a new value for followUp ()
|
Procedure |
addFollowUp(CodeableConceptDt theValue)
Adds a given new value for followUp ()
|
IdentifierDt |
addIdentifier()
Adds and returns a new value for identifier (id)
|
Procedure |
addIdentifier(IdentifierDt theValue)
Adds a given new value for identifier (id)
|
AnnotationDt |
addNotes()
Adds and returns a new value for notes ()
|
Procedure |
addNotes(AnnotationDt theValue)
Adds a given new value for notes ()
|
Procedure.Performer |
addPerformer()
Adds and returns a new value for performer ()
|
Procedure |
addPerformer(Procedure.Performer theValue)
Adds a given new value for performer ()
|
CodeableConceptDt |
addReasonNotPerformed()
Adds and returns a new value for reasonNotPerformed ()
|
Procedure |
addReasonNotPerformed(CodeableConceptDt theValue)
Adds a given new value for reasonNotPerformed ()
|
ResourceReferenceDt |
addReport()
Adds and returns a new value for report ()
|
ResourceReferenceDt |
addUsed()
Adds and returns a new value for used ()
|
<T extends IElement> |
getAllPopulatedChildElementsOfType(Class<T> theType) |
List<CodeableConceptDt> |
getBodySite()
Gets the value(s) for bodySite ().
|
CodeableConceptDt |
getBodySiteFirstRep()
Gets the first repetition for bodySite (),
creating it if it does not already exist.
|
CodeableConceptDt |
getCategory()
Gets the value(s) for category ().
|
CodeableConceptDt |
getCode()
Gets the value(s) for code (class).
|
List<CodeableConceptDt> |
getComplication()
Gets the value(s) for complication ().
|
CodeableConceptDt |
getComplicationFirstRep()
Gets the first repetition for complication (),
creating it if it does not already exist.
|
ResourceReferenceDt |
getEncounter()
Gets the value(s) for encounter (context).
|
List<Procedure.FocalDevice> |
getFocalDevice()
Gets the value(s) for focalDevice ().
|
Procedure.FocalDevice |
getFocalDeviceFirstRep()
Gets the first repetition for focalDevice (),
creating it if it does not already exist.
|
List<CodeableConceptDt> |
getFollowUp()
Gets the value(s) for followUp ().
|
CodeableConceptDt |
getFollowUpFirstRep()
Gets the first repetition for followUp (),
creating it if it does not already exist.
|
List<IdentifierDt> |
getIdentifier()
Gets the value(s) for identifier (id).
|
IdentifierDt |
getIdentifierFirstRep()
Gets the first repetition for identifier (id),
creating it if it does not already exist.
|
ResourceReferenceDt |
getLocation()
Gets the value(s) for location (where).
|
List<AnnotationDt> |
getNotes()
Gets the value(s) for notes ().
|
AnnotationDt |
getNotesFirstRep()
Gets the first repetition for notes (),
creating it if it does not already exist.
|
Boolean |
getNotPerformed()
Gets the value(s) for notPerformed ().
|
BooleanDt |
getNotPerformedElement()
Gets the value(s) for notPerformed ().
|
CodeableConceptDt |
getOutcome()
Gets the value(s) for outcome ().
|
IDatatype |
getPerformed()
Gets the value(s) for performed[x] (when.done).
|
List<Procedure.Performer> |
getPerformer()
Gets the value(s) for performer ().
|
Procedure.Performer |
getPerformerFirstRep()
Gets the first repetition for performer (),
creating it if it does not already exist.
|
IDatatype |
getReason()
Gets the value(s) for reason[x] ().
|
List<CodeableConceptDt> |
getReasonNotPerformed()
Gets the value(s) for reasonNotPerformed ().
|
CodeableConceptDt |
getReasonNotPerformedFirstRep()
Gets the first repetition for reasonNotPerformed (),
creating it if it does not already exist.
|
List<ResourceReferenceDt> |
getReport()
Gets the value(s) for report ().
|
ResourceReferenceDt |
getRequest()
Gets the value(s) for request ().
|
String |
getResourceName() |
String |
getStatus()
Gets the value(s) for status ().
|
BoundCodeDt<ProcedureStatusEnum> |
getStatusElement()
Gets the value(s) for status ().
|
FhirVersionEnum |
getStructureFhirVersionEnum() |
ResourceReferenceDt |
getSubject()
Gets the value(s) for subject (who.focus).
|
List<ResourceReferenceDt> |
getUsed()
Gets the value(s) for used ().
|
boolean |
isEmpty() |
Procedure |
setBodySite(List<CodeableConceptDt> theValue)
Sets the value(s) for bodySite ()
|
Procedure |
setCategory(CodeableConceptDt theValue)
Sets the value(s) for category ()
|
Procedure |
setCode(CodeableConceptDt theValue)
Sets the value(s) for code (class)
|
Procedure |
setComplication(List<CodeableConceptDt> theValue)
Sets the value(s) for complication ()
|
Procedure |
setEncounter(ResourceReferenceDt theValue)
Sets the value(s) for encounter (context)
|
Procedure |
setFocalDevice(List<Procedure.FocalDevice> theValue)
Sets the value(s) for focalDevice ()
|
Procedure |
setFollowUp(List<CodeableConceptDt> theValue)
Sets the value(s) for followUp ()
|
Procedure |
setIdentifier(List<IdentifierDt> theValue)
Sets the value(s) for identifier (id)
|
Procedure |
setLocation(ResourceReferenceDt theValue)
Sets the value(s) for location (where)
|
Procedure |
setNotes(List<AnnotationDt> theValue)
Sets the value(s) for notes ()
|
Procedure |
setNotPerformed(boolean theBoolean)
Sets the value for notPerformed ()
|
Procedure |
setNotPerformed(BooleanDt theValue)
Sets the value(s) for notPerformed ()
|
Procedure |
setOutcome(CodeableConceptDt theValue)
Sets the value(s) for outcome ()
|
Procedure |
setPerformed(IDatatype theValue)
Sets the value(s) for performed[x] (when.done)
|
Procedure |
setPerformer(List<Procedure.Performer> theValue)
Sets the value(s) for performer ()
|
Procedure |
setReason(IDatatype theValue)
Sets the value(s) for reason[x] ()
|
Procedure |
setReasonNotPerformed(List<CodeableConceptDt> theValue)
Sets the value(s) for reasonNotPerformed ()
|
Procedure |
setReport(List<ResourceReferenceDt> theValue)
Sets the value(s) for report ()
|
Procedure |
setRequest(ResourceReferenceDt theValue)
Sets the value(s) for request ()
|
Procedure |
setStatus(BoundCodeDt<ProcedureStatusEnum> theValue)
Sets the value(s) for status ()
|
Procedure |
setStatus(ProcedureStatusEnum theValue)
Sets the value(s) for status ()
|
Procedure |
setSubject(ResourceReferenceDt theValue)
Sets the value(s) for subject (who.focus)
|
Procedure |
setUsed(List<ResourceReferenceDt> theValue)
Sets the value(s) for used ()
|
getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toStringaddUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensionsclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadatagetIdElement, setId, setIdpublic static final String SP_CODE
Description: A code to identify a procedure
Type: token
Path: Procedure.code
public static final TokenClientParam CODE
Description: A code to identify a procedure
Type: token
Path: Procedure.code
public static final String SP_IDENTIFIER
Description: A unique identifier for a procedure
Type: token
Path: Procedure.identifier
public static final TokenClientParam IDENTIFIER
Description: A unique identifier for a procedure
Type: token
Path: Procedure.identifier
public static final String SP_DATE
Description:
Type: date
Path: Procedure.performed[x]
public static final DateClientParam DATE
Description:
Type: date
Path: Procedure.performed[x]
public static final String SP_PERFORMER
Description:
Type: reference
Path: Procedure.performer.actor
public static final ReferenceClientParam PERFORMER
Description:
Type: reference
Path: Procedure.performer.actor
public static final String SP_LOCATION
Description:
Type: reference
Path: Procedure.location
public static final ReferenceClientParam LOCATION
Description:
Type: reference
Path: Procedure.location
public static final String SP_ENCOUNTER
Description:
Type: reference
Path: Procedure.encounter
public static final ReferenceClientParam ENCOUNTER
Description:
Type: reference
Path: Procedure.encounter
public static final String SP_SUBJECT
Description: Search by subject
Type: reference
Path: Procedure.subject
public static final ReferenceClientParam SUBJECT
Description: Search by subject
Type: reference
Path: Procedure.subject
public static final String SP_PATIENT
Description: Search by subject - a patient
Type: reference
Path: Procedure.subject
public static final ReferenceClientParam PATIENT
Description: Search by subject - a patient
Type: reference
Path: Procedure.subject
public static final Include INCLUDE_ENCOUNTER
public static final Include INCLUDE_LOCATION
public static final Include INCLUDE_PATIENT
public static final Include INCLUDE_PERFORMER
public static final Include INCLUDE_SUBJECT
public Procedure()
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
getAllPopulatedChildElementsOfType in interface ICompositeElementpublic List<IdentifierDt> getIdentifier()
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)
public Procedure setIdentifier(List<IdentifierDt> theValue)
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)
public IdentifierDt addIdentifier()
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)
public Procedure addIdentifier(IdentifierDt theValue)
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)
theValue - The identifier to add (must not be null)public IdentifierDt getIdentifierFirstRep()
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)
public ResourceReferenceDt getSubject()
null.
Definition: The person, animal or group on which the procedure was performed
public Procedure setSubject(ResourceReferenceDt theValue)
Definition: The person, animal or group on which the procedure was performed
public BoundCodeDt<ProcedureStatusEnum> getStatusElement()
null.
Definition: A code specifying the state of the procedure. Generally this will be in-progress or completed state.
public String getStatus()
null.
Definition: A code specifying the state of the procedure. Generally this will be in-progress or completed state.
public Procedure setStatus(BoundCodeDt<ProcedureStatusEnum> theValue)
Definition: A code specifying the state of the procedure. Generally this will be in-progress or completed state.
public Procedure setStatus(ProcedureStatusEnum theValue)
Definition: A code specifying the state of the procedure. Generally this will be in-progress or completed state.
public CodeableConceptDt getCategory()
null.
Definition: A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\")
public Procedure setCategory(CodeableConceptDt theValue)
Definition: A code that classifies the procedure for searching, sorting and display purposes (e.g. \"Surgical Procedure\")
public CodeableConceptDt getCode()
null.
Definition: The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\")
public Procedure setCode(CodeableConceptDt theValue)
Definition: The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. \"Laparoscopic Appendectomy\")
public BooleanDt getNotPerformedElement()
null.
Definition: Set this to true if the record is saying that the procedure was NOT performed
public Boolean getNotPerformed()
null.
Definition: Set this to true if the record is saying that the procedure was NOT performed
public Procedure setNotPerformed(BooleanDt theValue)
Definition: Set this to true if the record is saying that the procedure was NOT performed
public Procedure setNotPerformed(boolean theBoolean)
Definition: Set this to true if the record is saying that the procedure was NOT performed
public List<CodeableConceptDt> getReasonNotPerformed()
null.
Definition: A code indicating why the procedure was not performed.
public Procedure setReasonNotPerformed(List<CodeableConceptDt> theValue)
Definition: A code indicating why the procedure was not performed.
public CodeableConceptDt addReasonNotPerformed()
Definition: A code indicating why the procedure was not performed.
public Procedure addReasonNotPerformed(CodeableConceptDt theValue)
Definition: A code indicating why the procedure was not performed.
theValue - The reasonNotPerformed to add (must not be null)public CodeableConceptDt getReasonNotPerformedFirstRep()
Definition: A code indicating why the procedure was not performed.
public List<CodeableConceptDt> getBodySite()
null.
Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion
public Procedure setBodySite(List<CodeableConceptDt> theValue)
Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion
public CodeableConceptDt addBodySite()
Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion
public Procedure addBodySite(CodeableConceptDt theValue)
Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion
theValue - The bodySite to add (must not be null)public CodeableConceptDt getBodySiteFirstRep()
Definition: Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion
public IDatatype getReason()
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
public Procedure setReason(IDatatype theValue)
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
public List<Procedure.Performer> getPerformer()
null.
Definition: Limited to 'real' people rather than equipment
public Procedure setPerformer(List<Procedure.Performer> theValue)
Definition: Limited to 'real' people rather than equipment
public Procedure.Performer addPerformer()
Definition: Limited to 'real' people rather than equipment
public Procedure addPerformer(Procedure.Performer theValue)
Definition: Limited to 'real' people rather than equipment
theValue - The performer to add (must not be null)public Procedure.Performer getPerformerFirstRep()
Definition: Limited to 'real' people rather than equipment
public IDatatype getPerformed()
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.
public Procedure setPerformed(IDatatype theValue)
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.
public ResourceReferenceDt getEncounter()
null.
Definition: The encounter during which the procedure was performed
public Procedure setEncounter(ResourceReferenceDt theValue)
Definition: The encounter during which the procedure was performed
public ResourceReferenceDt getLocation()
null.
Definition: The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant
public Procedure setLocation(ResourceReferenceDt theValue)
Definition: The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant
public CodeableConceptDt getOutcome()
null.
Definition: The outcome of the procedure - did it resolve reasons for the procedure being performed?
public Procedure setOutcome(CodeableConceptDt theValue)
Definition: The outcome of the procedure - did it resolve reasons for the procedure being performed?
public List<ResourceReferenceDt> getReport()
null.
Definition: This could be a histology result, pathology report, surgical report, etc..
public Procedure setReport(List<ResourceReferenceDt> theValue)
Definition: This could be a histology result, pathology report, surgical report, etc..
public ResourceReferenceDt addReport()
Definition: This could be a histology result, pathology report, surgical report, etc..
public List<CodeableConceptDt> getComplication()
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
public Procedure setComplication(List<CodeableConceptDt> theValue)
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
public CodeableConceptDt addComplication()
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
public Procedure addComplication(CodeableConceptDt theValue)
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
theValue - The complication to add (must not be null)public CodeableConceptDt getComplicationFirstRep()
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
public List<CodeableConceptDt> getFollowUp()
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
public Procedure setFollowUp(List<CodeableConceptDt> theValue)
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
public CodeableConceptDt addFollowUp()
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
public Procedure addFollowUp(CodeableConceptDt theValue)
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
theValue - The followUp to add (must not be null)public CodeableConceptDt getFollowUpFirstRep()
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
public ResourceReferenceDt getRequest()
null.
Definition: A reference to a resource that contains details of the request for this procedure.
public Procedure setRequest(ResourceReferenceDt theValue)
Definition: A reference to a resource that contains details of the request for this procedure.
public List<AnnotationDt> getNotes()
null.
Definition: Any other notes about the procedure. E.g. the operative notes
public Procedure setNotes(List<AnnotationDt> theValue)
Definition: Any other notes about the procedure. E.g. the operative notes
public AnnotationDt addNotes()
Definition: Any other notes about the procedure. E.g. the operative notes
public Procedure addNotes(AnnotationDt theValue)
Definition: Any other notes about the procedure. E.g. the operative notes
theValue - The notes to add (must not be null)public AnnotationDt getNotesFirstRep()
Definition: Any other notes about the procedure. E.g. the operative notes
public List<Procedure.FocalDevice> getFocalDevice()
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.
public Procedure setFocalDevice(List<Procedure.FocalDevice> theValue)
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.
public Procedure.FocalDevice addFocalDevice()
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.
public Procedure addFocalDevice(Procedure.FocalDevice theValue)
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.
theValue - The focalDevice to add (must not be null)public Procedure.FocalDevice getFocalDeviceFirstRep()
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.
public List<ResourceReferenceDt> getUsed()
null.
Definition: Identifies medications, devices and any other substance used as part of the procedure
public Procedure setUsed(List<ResourceReferenceDt> theValue)
Definition: Identifies medications, devices and any other substance used as part of the procedure
public ResourceReferenceDt addUsed()
Definition: Identifies medications, devices and any other substance used as part of the procedure
public String getResourceName()
getResourceName in interface IResourcepublic FhirVersionEnum getStructureFhirVersionEnum()
getStructureFhirVersionEnum in interface IResourcegetStructureFhirVersionEnum in interface IBaseResourceCopyright © 2014–2016 University Health Network. All rights reserved.