
Class Procedure
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.model.Procedure
-
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
public class Procedure extends DomainResource
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.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Procedure.ProcedureFocalDeviceComponent
static class
Procedure.ProcedurePerformerComponent
static class
Procedure.ProcedureStatus
static class
Procedure.ProcedureStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.ReferenceClientParam
BASED_ON
Fluent Client search parameter constant for based-onprotected List<Reference>
basedOn
A reference to a resource that contains details of the request for this procedure.protected List<Resource>
basedOnTarget
The actual objects that are the target of the reference (A reference to a resource that contains details of the request for this procedure.)protected List<CodeableConcept>
bodySite
Detailed and structured anatomical location information.protected CodeableConcept
category
A code that classifies the procedure for searching, sorting and display purposes (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParam
CATEGORY
Fluent Client search parameter constant for categoryprotected CodeableConcept
code
The specific procedure that is performed.static ca.uhn.fhir.rest.gclient.TokenClientParam
CODE
Fluent Client search parameter constant for codeprotected List<CodeableConcept>
complication
Any complications that occurred during the procedure, or in the immediate post-performance period.protected List<Reference>
complicationDetail
Any complications that occurred during the procedure, or in the immediate post-performance period.protected List<Condition>
complicationDetailTarget
The actual objects that are the target of the reference (Any complications that occurred during the procedure, or in the immediate post-performance period.)protected Reference
context
The encounter during which the procedure was performed.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
CONTEXT
Fluent Client search parameter constant for contextprotected Resource
contextTarget
The actual object that is the target of the reference (The encounter during which the procedure was performed.)static ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for dateprotected List<Reference>
definition
A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
DEFINITION
Fluent Client search parameter constant for definitionprotected List<Resource>
definitionTarget
The actual objects that are the target of the reference (A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.)static ca.uhn.fhir.rest.gclient.ReferenceClientParam
ENCOUNTER
Fluent Client search parameter constant for encounterprotected List<Procedure.ProcedureFocalDeviceComponent>
focalDevice
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.protected List<CodeableConcept>
followUp
If the procedure required specific follow up - e.g.protected List<Identifier>
identifier
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.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_DEFINITION
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements.protected Reference
location
The location where the procedure actually happened.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
LOCATION
Fluent Client search parameter constant for locationprotected Location
locationTarget
The actual object that is the target of the reference (The location where the procedure actually happened.protected BooleanType
notDone
Set this to true if the record is saying that the procedure was NOT performed.protected CodeableConcept
notDoneReason
A code indicating why the procedure was not performed.protected List<Annotation>
note
Any other notes about the procedure.protected CodeableConcept
outcome
The outcome of the procedure - did it resolve reasons for the procedure being performed?static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PART_OF
Fluent Client search parameter constant for part-ofprotected List<Reference>
partOf
A larger event of which this particular procedure is a component or step.protected List<Resource>
partOfTarget
The actual objects that are the target of the reference (A larger event of which this particular procedure is a component or step.)static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientprotected Type
performed
The date(time)/period over which the procedure was performed.protected List<Procedure.ProcedurePerformerComponent>
performer
Limited to 'real' people rather than equipment.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PERFORMER
Fluent Client search parameter constant for performerprotected List<CodeableConcept>
reasonCode
The coded reason why the procedure was performed.protected List<Reference>
reasonReference
The condition that is the reason why the procedure was performed.protected List<Resource>
reasonReferenceTarget
The actual objects that are the target of the reference (The condition that is the reason why the procedure was performed.)protected List<Reference>
report
This could be a histology result, pathology report, surgical report, etc..protected List<DiagnosticReport>
reportTarget
The actual objects that are the target of the reference (This could be a histology result, pathology report, surgical report, etc..)static String
SP_BASED_ON
Search parameter: based-onstatic String
SP_CATEGORY
Search parameter: categorystatic String
SP_CODE
Search parameter: codestatic String
SP_CONTEXT
Search parameter: contextstatic String
SP_DATE
Search parameter: datestatic String
SP_DEFINITION
Search parameter: definitionstatic String
SP_ENCOUNTER
Search parameter: encounterstatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_LOCATION
Search parameter: locationstatic String
SP_PART_OF
Search parameter: part-ofstatic String
SP_PATIENT
Search parameter: patientstatic String
SP_PERFORMER
Search parameter: performerstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUBJECT
Search parameter: subjectprotected Enumeration<Procedure.ProcedureStatus>
status
A code specifying the state of the procedure.static ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusprotected Reference
subject
The person, animal or group on which the procedure was performed.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUBJECT
Fluent Client search parameter constant for subjectprotected Resource
subjectTarget
The actual object that is the target of the reference (The person, animal or group on which the procedure was performed.)protected List<CodeableConcept>
usedCode
Identifies coded items that were used as part of the procedure.protected List<Reference>
usedReference
Identifies medications, devices and any other substance used as part of the procedure.protected List<Resource>
usedReferenceTarget
The actual objects that are the target of the reference (Identifies medications, devices and any other substance used as part of the procedure.)-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description Procedure()
ConstructorProcedure(Enumeration<Procedure.ProcedureStatus> status, Reference subject)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setUserData, setUserDataINN
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserData
-
-
-
-
Field Detail
-
identifier
protected List<Identifier> identifier
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).
-
definition
protected List<Reference> definition
A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.
-
definitionTarget
protected List<Resource> definitionTarget
The actual objects that are the target of the reference (A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.)
-
basedOn
protected List<Reference> basedOn
A reference to a resource that contains details of the request for this procedure.
-
basedOnTarget
protected List<Resource> basedOnTarget
The actual objects that are the target of the reference (A reference to a resource that contains details of the request for this procedure.)
-
partOf
protected List<Reference> partOf
A larger event of which this particular procedure is a component or step.
-
partOfTarget
protected List<Resource> partOfTarget
The actual objects that are the target of the reference (A larger event of which this particular procedure is a component or step.)
-
status
protected Enumeration<Procedure.ProcedureStatus> status
A code specifying the state of the procedure. Generally this will be in-progress or completed state.
-
notDone
protected BooleanType notDone
Set this to true if the record is saying that the procedure was NOT performed.
-
notDoneReason
protected CodeableConcept notDoneReason
A code indicating why the procedure was not performed.
-
category
protected CodeableConcept category
A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").
-
code
protected CodeableConcept code
The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").
-
subject
protected Reference subject
The person, animal or group on which the procedure was performed.
-
subjectTarget
protected Resource subjectTarget
The actual object that is the target of the reference (The person, animal or group on which the procedure was performed.)
-
contextTarget
protected Resource contextTarget
The actual object that is the target of the reference (The encounter during which the procedure was performed.)
-
performed
protected Type performed
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.
-
performer
protected List<Procedure.ProcedurePerformerComponent> performer
Limited to 'real' people rather than equipment.
-
location
protected Reference location
The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.
-
locationTarget
protected Location locationTarget
The actual object that is the target of the reference (The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)
-
reasonCode
protected List<CodeableConcept> reasonCode
The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.
-
reasonReference
protected List<Reference> reasonReference
The condition that is the reason why the procedure was performed.
-
reasonReferenceTarget
protected List<Resource> reasonReferenceTarget
The actual objects that are the target of the reference (The condition that is the reason why the procedure was performed.)
-
bodySite
protected List<CodeableConcept> bodySite
Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.
-
outcome
protected CodeableConcept outcome
The outcome of the procedure - did it resolve reasons for the procedure being performed?
-
report
protected List<Reference> report
This could be a histology result, pathology report, surgical report, etc..
-
reportTarget
protected List<DiagnosticReport> reportTarget
The actual objects that are the target of the reference (This could be a histology result, pathology report, surgical report, etc..)
-
complication
protected List<CodeableConcept> complication
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.
-
complicationDetail
protected List<Reference> complicationDetail
Any complications that occurred during the procedure, or in the immediate post-performance period.
-
complicationDetailTarget
protected List<Condition> complicationDetailTarget
The actual objects that are the target of the reference (Any complications that occurred during the procedure, or in the immediate post-performance period.)
-
followUp
protected List<CodeableConcept> followUp
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.
-
note
protected List<Annotation> note
Any other notes about the procedure. E.g. the operative notes.
-
focalDevice
protected List<Procedure.ProcedureFocalDeviceComponent> focalDevice
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.
-
usedReference
protected List<Reference> usedReference
Identifies medications, devices and any other substance used as part of the procedure.
-
usedReferenceTarget
protected List<Resource> usedReferenceTarget
The actual objects that are the target of the reference (Identifies medications, devices and any other substance used as part of the procedure.)
-
usedCode
protected List<CodeableConcept> usedCode
Identifies coded items that were used as part of the procedure.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Date/Period the procedure was performed
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 dateDescription: Date/Period the procedure was performed
Type: date
Path: Procedure.performed[x]
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: 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 identifierDescription: A unique identifier for a procedure
Type: token
Path: Procedure.identifier
-
SP_CODE
public static final String SP_CODE
Search parameter: codeDescription: 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 codeDescription: A code to identify a procedure
Type: token
Path: Procedure.code
-
SP_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: The reference to the practitioner
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 performerDescription: The reference to the practitioner
Type: reference
Path: Procedure.performer.actor
-
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".
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: 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 subjectDescription: Search by subject
Type: reference
Path: Procedure.subject
-
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".
-
SP_PART_OF
public static final String SP_PART_OF
Search parameter: part-ofDescription: Part of referenced event
Type: reference
Path: Procedure.partOf
- See Also:
- Constant Field Values
-
PART_OF
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PART_OF
Fluent Client search parameter constant for part-ofDescription: Part of referenced event
Type: reference
Path: Procedure.partOf
-
INCLUDE_PART_OF
public static final ca.uhn.fhir.model.api.Include INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:part-of".
-
SP_ENCOUNTER
public static final String SP_ENCOUNTER
Search parameter: encounterDescription: Search by encounter
Type: reference
Path: Procedure.context
- See Also:
- Constant Field Values
-
ENCOUNTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Search by encounter
Type: reference
Path: Procedure.context
-
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".
-
SP_BASED_ON
public static final String SP_BASED_ON
Search parameter: based-onDescription: A request for this procedure
Type: reference
Path: Procedure.basedOn
- See Also:
- Constant Field Values
-
BASED_ON
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam BASED_ON
Fluent Client search parameter constant for based-onDescription: A request for this procedure
Type: reference
Path: Procedure.basedOn
-
INCLUDE_BASED_ON
public static final ca.uhn.fhir.model.api.Include INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:based-on".
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: 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 patientDescription: Search by subject - a patient
Type: reference
Path: Procedure.subject
-
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".
-
SP_CONTEXT
public static final String SP_CONTEXT
Search parameter: contextDescription: Encounter or episode associated with the procedure
Type: reference
Path: Procedure.context
- See Also:
- Constant Field Values
-
CONTEXT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam CONTEXT
Fluent Client search parameter constant for contextDescription: Encounter or episode associated with the procedure
Type: reference
Path: Procedure.context
-
INCLUDE_CONTEXT
public static final ca.uhn.fhir.model.api.Include INCLUDE_CONTEXT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:context".
-
SP_LOCATION
public static final String SP_LOCATION
Search parameter: locationDescription: Where the procedure happened
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 locationDescription: Where the procedure happened
Type: reference
Path: Procedure.location
-
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".
-
SP_DEFINITION
public static final String SP_DEFINITION
Search parameter: definitionDescription: Instantiates protocol or definition
Type: reference
Path: Procedure.definition
- See Also:
- Constant Field Values
-
DEFINITION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam DEFINITION
Fluent Client search parameter constant for definitionDescription: Instantiates protocol or definition
Type: reference
Path: Procedure.definition
-
INCLUDE_DEFINITION
public static final ca.uhn.fhir.model.api.Include INCLUDE_DEFINITION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:definition".
-
SP_CATEGORY
public static final String SP_CATEGORY
Search parameter: categoryDescription: Classification of the procedure
Type: token
Path: Procedure.category
- See Also:
- Constant Field Values
-
CATEGORY
public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
Fluent Client search parameter constant for categoryDescription: Classification of the procedure
Type: token
Path: Procedure.category
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
Type: token
Path: Procedure.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: preparation | in-progress | suspended | aborted | completed | entered-in-error | unknown
Type: token
Path: Procedure.status
-
-
Constructor Detail
-
Procedure
public Procedure()
Constructor
-
Procedure
public Procedure(Enumeration<Procedure.ProcedureStatus> status, Reference subject)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier
(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<Identifier> theIdentifier)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public Procedure addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getDefinition
public List<Reference> getDefinition()
- Returns:
definition
(A protocol, guideline, orderset or other definition that was adhered to in whole or in part by this procedure.)
-
setDefinition
public Procedure setDefinition(List<Reference> theDefinition)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasDefinition
public boolean hasDefinition()
-
addDefinition
public Reference addDefinition()
-
addDefinition
public Procedure addDefinition(Reference t)
-
getDefinitionFirstRep
public Reference getDefinitionFirstRep()
- Returns:
- The first repetition of repeating field
definition
, creating it if it does not already exist
-
getDefinitionTarget
@Deprecated public List<Resource> getDefinitionTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getBasedOn
public List<Reference> getBasedOn()
- Returns:
basedOn
(A reference to a resource that contains details of the request for this procedure.)
-
setBasedOn
public Procedure setBasedOn(List<Reference> theBasedOn)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
public boolean hasBasedOn()
-
addBasedOn
public Reference addBasedOn()
-
addBasedOn
public Procedure addBasedOn(Reference t)
-
getBasedOnFirstRep
public Reference getBasedOnFirstRep()
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist
-
getBasedOnTarget
@Deprecated public List<Resource> getBasedOnTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getPartOf
public List<Reference> getPartOf()
- Returns:
partOf
(A larger event of which this particular procedure is a component or step.)
-
setPartOf
public Procedure setPartOf(List<Reference> thePartOf)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
public boolean hasPartOf()
-
getPartOfFirstRep
public Reference getPartOfFirstRep()
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist
-
getPartOfTarget
@Deprecated public List<Resource> getPartOfTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getStatusElement
public Enumeration<Procedure.ProcedureStatus> getStatusElement()
- Returns:
status
(A code specifying the state of the procedure. Generally this will be in-progress or completed state.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Procedure setStatusElement(Enumeration<Procedure.ProcedureStatus> value)
- Parameters:
value
-status
(A code specifying the state of the procedure. Generally this will be in-progress or completed state.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
public Procedure.ProcedureStatus getStatus()
- Returns:
- A code specifying the state of the procedure. Generally this will be in-progress or completed state.
-
setStatus
public Procedure setStatus(Procedure.ProcedureStatus value)
- Parameters:
value
- A code specifying the state of the procedure. Generally this will be in-progress or completed state.
-
getNotDoneElement
public BooleanType getNotDoneElement()
- Returns:
notDone
(Set this to true if the record is saying that the procedure was NOT performed.). This is the underlying object with id, value and extensions. The accessor "getNotDone" gives direct access to the value
-
hasNotDoneElement
public boolean hasNotDoneElement()
-
hasNotDone
public boolean hasNotDone()
-
setNotDoneElement
public Procedure setNotDoneElement(BooleanType value)
- Parameters:
value
-notDone
(Set this to true if the record is saying that the procedure was NOT performed.). This is the underlying object with id, value and extensions. The accessor "getNotDone" gives direct access to the value
-
getNotDone
public boolean getNotDone()
- Returns:
- Set this to true if the record is saying that the procedure was NOT performed.
-
setNotDone
public Procedure setNotDone(boolean value)
- Parameters:
value
- Set this to true if the record is saying that the procedure was NOT performed.
-
getNotDoneReason
public CodeableConcept getNotDoneReason()
- Returns:
notDoneReason
(A code indicating why the procedure was not performed.)
-
hasNotDoneReason
public boolean hasNotDoneReason()
-
setNotDoneReason
public Procedure setNotDoneReason(CodeableConcept value)
- Parameters:
value
-notDoneReason
(A code indicating why the procedure was not performed.)
-
getCategory
public CodeableConcept getCategory()
- Returns:
category
(A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").)
-
hasCategory
public boolean hasCategory()
-
setCategory
public Procedure setCategory(CodeableConcept value)
- Parameters:
value
-category
(A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").)
-
getCode
public CodeableConcept getCode()
- Returns:
code
(The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").)
-
hasCode
public boolean hasCode()
-
setCode
public Procedure setCode(CodeableConcept value)
- Parameters:
value
-code
(The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy").)
-
getSubject
public Reference getSubject()
- Returns:
subject
(The person, animal or group on which the procedure was performed.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public Procedure setSubject(Reference value)
- Parameters:
value
-subject
(The person, animal or group on which the procedure was performed.)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
subject
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The person, animal or group on which the procedure was performed.)
-
setSubjectTarget
public Procedure setSubjectTarget(Resource value)
- Parameters:
value
-subject
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The person, animal or group on which the procedure was performed.)
-
getContext
public Reference getContext()
- Returns:
context
(The encounter during which the procedure was performed.)
-
hasContext
public boolean hasContext()
-
setContext
public Procedure setContext(Reference value)
- Parameters:
value
-context
(The encounter during which the procedure was performed.)
-
getContextTarget
public Resource getContextTarget()
- Returns:
context
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The encounter during which the procedure was performed.)
-
setContextTarget
public Procedure setContextTarget(Resource value)
- Parameters:
value
-context
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The encounter during which the procedure was performed.)
-
getPerformed
public Type getPerformed()
- Returns:
performed
(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.)
-
getPerformedDateTimeType
public DateTimeType getPerformedDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
performed
(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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasPerformedDateTimeType
public boolean hasPerformedDateTimeType()
-
getPerformedPeriod
public Period getPerformedPeriod() throws org.hl7.fhir.exceptions.FHIRException
- Returns:
performed
(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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasPerformedPeriod
public boolean hasPerformedPeriod()
-
hasPerformed
public boolean hasPerformed()
-
setPerformed
public Procedure setPerformed(Type value) throws org.hl7.fhir.exceptions.FHIRFormatError
- Parameters:
value
-performed
(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.)- Throws:
org.hl7.fhir.exceptions.FHIRFormatError
-
getPerformer
public List<Procedure.ProcedurePerformerComponent> getPerformer()
- Returns:
performer
(Limited to 'real' people rather than equipment.)
-
setPerformer
public Procedure setPerformer(List<Procedure.ProcedurePerformerComponent> thePerformer)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
public boolean hasPerformer()
-
addPerformer
public Procedure.ProcedurePerformerComponent addPerformer()
-
addPerformer
public Procedure addPerformer(Procedure.ProcedurePerformerComponent t)
-
getPerformerFirstRep
public Procedure.ProcedurePerformerComponent getPerformerFirstRep()
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist
-
getLocation
public Reference getLocation()
- Returns:
location
(The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)
-
hasLocation
public boolean hasLocation()
-
setLocation
public Procedure setLocation(Reference value)
- Parameters:
value
-location
(The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)
-
getLocationTarget
public Location getLocationTarget()
- Returns:
location
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)
-
setLocationTarget
public Procedure setLocationTarget(Location value)
- Parameters:
value
-location
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)
-
getReasonCode
public List<CodeableConcept> getReasonCode()
- Returns:
reasonCode
(The coded reason why the procedure was performed. This may be coded entity of some type, or may simply be present as text.)
-
setReasonCode
public Procedure setReasonCode(List<CodeableConcept> theReasonCode)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonCode
public boolean hasReasonCode()
-
addReasonCode
public CodeableConcept addReasonCode()
-
addReasonCode
public Procedure addReasonCode(CodeableConcept t)
-
getReasonCodeFirstRep
public CodeableConcept getReasonCodeFirstRep()
- Returns:
- The first repetition of repeating field
reasonCode
, creating it if it does not already exist
-
getReasonReference
public List<Reference> getReasonReference()
- Returns:
reasonReference
(The condition that is the reason why the procedure was performed.)
-
setReasonReference
public Procedure setReasonReference(List<Reference> theReasonReference)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReasonReference
public boolean hasReasonReference()
-
addReasonReference
public Reference addReasonReference()
-
addReasonReference
public Procedure addReasonReference(Reference t)
-
getReasonReferenceFirstRep
public Reference getReasonReferenceFirstRep()
- Returns:
- The first repetition of repeating field
reasonReference
, creating it if it does not already exist
-
getReasonReferenceTarget
@Deprecated public List<Resource> getReasonReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getBodySite
public List<CodeableConcept> getBodySite()
- Returns:
bodySite
(Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.)
-
setBodySite
public Procedure setBodySite(List<CodeableConcept> theBodySite)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBodySite
public boolean hasBodySite()
-
addBodySite
public CodeableConcept addBodySite()
-
addBodySite
public Procedure addBodySite(CodeableConcept t)
-
getBodySiteFirstRep
public CodeableConcept getBodySiteFirstRep()
- Returns:
- The first repetition of repeating field
bodySite
, creating it if it does not already exist
-
getOutcome
public CodeableConcept getOutcome()
- Returns:
outcome
(The outcome of the procedure - did it resolve reasons for the procedure being performed?)
-
hasOutcome
public boolean hasOutcome()
-
setOutcome
public Procedure setOutcome(CodeableConcept value)
- Parameters:
value
-outcome
(The outcome of the procedure - did it resolve reasons for the procedure being performed?)
-
getReport
public List<Reference> getReport()
- Returns:
report
(This could be a histology result, pathology report, surgical report, etc..)
-
setReport
public Procedure setReport(List<Reference> theReport)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReport
public boolean hasReport()
-
getReportFirstRep
public Reference getReportFirstRep()
- Returns:
- The first repetition of repeating field
report
, creating it if it does not already exist
-
getReportTarget
@Deprecated public List<DiagnosticReport> getReportTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addReportTarget
@Deprecated public DiagnosticReport addReportTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getComplication
public List<CodeableConcept> getComplication()
- Returns:
complication
(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
public Procedure setComplication(List<CodeableConcept> theComplication)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasComplication
public boolean hasComplication()
-
addComplication
public CodeableConcept addComplication()
-
addComplication
public Procedure addComplication(CodeableConcept t)
-
getComplicationFirstRep
public CodeableConcept getComplicationFirstRep()
- Returns:
- The first repetition of repeating field
complication
, creating it if it does not already exist
-
getComplicationDetail
public List<Reference> getComplicationDetail()
- Returns:
complicationDetail
(Any complications that occurred during the procedure, or in the immediate post-performance period.)
-
setComplicationDetail
public Procedure setComplicationDetail(List<Reference> theComplicationDetail)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasComplicationDetail
public boolean hasComplicationDetail()
-
addComplicationDetail
public Reference addComplicationDetail()
-
addComplicationDetail
public Procedure addComplicationDetail(Reference t)
-
getComplicationDetailFirstRep
public Reference getComplicationDetailFirstRep()
- Returns:
- The first repetition of repeating field
complicationDetail
, creating it if it does not already exist
-
getComplicationDetailTarget
@Deprecated public List<Condition> getComplicationDetailTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
addComplicationDetailTarget
@Deprecated public Condition addComplicationDetailTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getFollowUp
public List<CodeableConcept> getFollowUp()
- Returns:
followUp
(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
public Procedure setFollowUp(List<CodeableConcept> theFollowUp)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasFollowUp
public boolean hasFollowUp()
-
addFollowUp
public CodeableConcept addFollowUp()
-
addFollowUp
public Procedure addFollowUp(CodeableConcept t)
-
getFollowUpFirstRep
public CodeableConcept getFollowUpFirstRep()
- Returns:
- The first repetition of repeating field
followUp
, creating it if it does not already exist
-
getNote
public List<Annotation> getNote()
- Returns:
note
(Any other notes about the procedure. E.g. the operative notes.)
-
setNote
public Procedure setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public Procedure addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
getFocalDevice
public List<Procedure.ProcedureFocalDeviceComponent> getFocalDevice()
- Returns:
focalDevice
(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
public Procedure setFocalDevice(List<Procedure.ProcedureFocalDeviceComponent> theFocalDevice)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasFocalDevice
public boolean hasFocalDevice()
-
addFocalDevice
public Procedure.ProcedureFocalDeviceComponent addFocalDevice()
-
addFocalDevice
public Procedure addFocalDevice(Procedure.ProcedureFocalDeviceComponent t)
-
getFocalDeviceFirstRep
public Procedure.ProcedureFocalDeviceComponent getFocalDeviceFirstRep()
- Returns:
- The first repetition of repeating field
focalDevice
, creating it if it does not already exist
-
getUsedReference
public List<Reference> getUsedReference()
- Returns:
usedReference
(Identifies medications, devices and any other substance used as part of the procedure.)
-
setUsedReference
public Procedure setUsedReference(List<Reference> theUsedReference)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUsedReference
public boolean hasUsedReference()
-
addUsedReference
public Reference addUsedReference()
-
addUsedReference
public Procedure addUsedReference(Reference t)
-
getUsedReferenceFirstRep
public Reference getUsedReferenceFirstRep()
- Returns:
- The first repetition of repeating field
usedReference
, creating it if it does not already exist
-
getUsedReferenceTarget
@Deprecated public List<Resource> getUsedReferenceTarget()
Deprecated.Use Reference#setResource(IBaseResource) instead
-
getUsedCode
public List<CodeableConcept> getUsedCode()
- Returns:
usedCode
(Identifies coded items that were used as part of the procedure.)
-
setUsedCode
public Procedure setUsedCode(List<CodeableConcept> theUsedCode)
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUsedCode
public boolean hasUsedCode()
-
addUsedCode
public CodeableConcept addUsedCode()
-
addUsedCode
public Procedure addUsedCode(CodeableConcept t)
-
getUsedCodeFirstRep
public CodeableConcept getUsedCodeFirstRep()
- Returns:
- The first repetition of repeating field
usedCode
, creating it if it does not already exist
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public Procedure copy()
- Specified by:
copy
in classDomainResource
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-