
Class 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
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
Nested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for based-onA reference to a resource that contains details of the request for this procedure.protected List<CodeableConcept>
Detailed and structured anatomical location information.protected List<CodeableConcept>
A code that classifies the procedure for searching, sorting and display purposes (e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for categoryprotected CodeableConcept
The specific procedure that is performed.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected List<CodeableReference>
Any complications that occurred during the procedure, or in the immediate post-performance period.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for dateprotected Reference
The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterprotected List<Procedure.ProcedureFocalDeviceComponent>
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 Reference
Who is the target of the procedure when it is not the subject of record only.protected List<CodeableConcept>
If the procedure required specific follow up - e.g.protected List<Identifier>
Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for instantiates-canonicalstatic final ca.uhn.fhir.rest.gclient.UriClientParam
Fluent Client search parameter constant for instantiates-uriprotected List<CanonicalType>
The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.protected Reference
The location where the procedure actually happened.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for locationprotected List<Annotation>
Any other notes and comments about the procedure.protected DataType
Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring.protected CodeableConcept
The outcome of the procedure - did it resolve the reasons for the procedure being performed?static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for part-ofA larger event of which this particular procedure is a component or step.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected List<Procedure.ProcedurePerformerComponent>
Limited to "real" people rather than equipment.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for performerprotected List<CodeableReference>
The coded reason or reference why the procedure was performed.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for reason-codestatic final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for reason-referenceprotected DateTimeType
The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).protected Reference
Individual who recorded the record and takes responsibility for its content.This could be a histology result, pathology report, surgical report, etc.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for reportprotected DataType
Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record.static final String
Search parameter: based-onstatic final String
Search parameter: categorystatic final String
Search parameter: codestatic final String
Search parameter: datestatic final String
Search parameter: encounterstatic final String
Search parameter: identifierstatic final String
Search parameter: instantiates-canonicalstatic final String
Search parameter: instantiates-uristatic final String
Search parameter: locationstatic final String
Search parameter: part-ofstatic final String
Search parameter: patientstatic final String
Search parameter: performerstatic final String
Search parameter: reason-codestatic final String
Search parameter: reason-referencestatic final String
Search parameter: reportstatic final String
Search parameter: statusstatic final String
Search parameter: subjectprotected Enumeration<Enumerations.EventStatus>
A code specifying the state of the procedure.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected CodeableConcept
Captures the reason for the current state of the procedure.protected Reference
On whom or on what the procedure was performed.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectOther resources from the patient record that may be relevant to the procedure.protected List<CodeableReference>
Identifies medications, devices and any other substance used as part of the procedure.Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
Fields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, SP_RES_ID
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorsConstructorDescriptionConstructorProcedure
(Enumerations.EventStatus status, Reference subject) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddInstantiatesCanonical
(String value) addInstantiatesUri
(String value) addNote()
addUsed()
copy()
void
copyValues
(Procedure dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getFocus()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Base[]
getProperty
(int hash, String name, boolean checkValid) String[]
getTypesForProperty
(int hash, String name) getUsed()
boolean
boolean
boolean
boolean
hasCode()
boolean
boolean
boolean
boolean
hasFocus()
boolean
boolean
boolean
boolean
hasInstantiatesCanonical
(String value) boolean
boolean
hasInstantiatesUri
(String value) boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasUsed()
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) setBasedOn
(List<Reference> theBasedOn) setBodySite
(List<CodeableConcept> theBodySite) setCategory
(List<CodeableConcept> theCategory) setCode
(CodeableConcept value) setComplication
(List<CodeableReference> theComplication) setEncounter
(Reference value) setFocalDevice
(List<Procedure.ProcedureFocalDeviceComponent> theFocalDevice) setFollowUp
(List<CodeableConcept> theFollowUp) setIdentifier
(List<Identifier> theIdentifier) setInstantiatesCanonical
(List<CanonicalType> theInstantiatesCanonical) setInstantiatesUri
(List<UriType> theInstantiatesUri) setLocation
(Reference value) setNote
(List<Annotation> theNote) setOccurrence
(DataType value) setOutcome
(CodeableConcept value) setPerformer
(List<Procedure.ProcedurePerformerComponent> thePerformer) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setReason
(List<CodeableReference> theReason) setRecorded
(Date value) setRecordedElement
(DateTimeType value) setRecorder
(Reference value) setReported
(DataType value) setStatusReason
(CodeableConcept value) setSubject
(Reference value) setSupportingInfo
(List<Reference> theSupportingInfo) setUsed
(List<CodeableReference> theUsed) protected Procedure
Methods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
Methods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage
Methods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, hasValidationInfo, isBooleanPrimitive, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, removeChild, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, setId
-
Field Details
-
identifier
Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server. -
instantiatesCanonical
The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. -
instantiatesUri
The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure. -
basedOn
A reference to a resource that contains details of the request for this procedure. -
partOf
A larger event of which this particular procedure is a component or step. -
status
A code specifying the state of the procedure. Generally, this will be the in-progress or completed state. -
statusReason
Captures the reason for the current state of the procedure. -
category
A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure"). -
code
The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy"). -
subject
On whom or on what the procedure was performed. This is usually an individual human, but can also be performed on animals, groups of humans or animals, organizations or practitioners (for licensing), locations or devices (for safety inspections or regulatory authorizations). If the actual focus of the procedure is different from the subject, the focus element specifies the actual focus of the procedure. -
focus
Who is the target of the procedure when it is not the subject of record only. If focus is not present, then subject is the focus. If focus is present and the subject is one of the targets of the procedure, include subject as a focus as well. If focus is present and the subject is not included in focus, it implies that the procedure was only targeted on the focus. For example, when a caregiver is given education for a patient, the caregiver would be the focus and the procedure record is associated with the subject (e.g. patient). For example, use focus when recording the target of the education, training, or counseling is the parent or relative of a patient. -
encounter
The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated. -
occurrence
Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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. -
recorded
The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event). -
recorder
Individual who recorded the record and takes responsibility for its content. -
reported
Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report. -
performer
Limited to "real" people rather than equipment. -
location
The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant. -
reason
The coded reason or reference why the procedure was performed. This may be a coded entity of some type, be present as text, or be a reference to one of several resources that justify the procedure. -
bodySite
Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion. -
outcome
The outcome of the procedure - did it resolve the reasons for the procedure being performed? -
report
This could be a histology result, pathology report, surgical report, etc. -
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. -
followUp
If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used. -
note
Any other notes and comments about the procedure. -
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. -
used
Identifies medications, devices and any other substance used as part of the procedure. -
supportingInfo
Other resources from the patient record that may be relevant to the procedure. The information from these resources was either used to create the instance or is provided to help with its interpretation. This extension should not be used if more specific inline elements or extensions are available. -
SP_BASED_ON
Search parameter: based-onDescription: A request for this procedure
Type: reference
Path: Procedure.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: A request for this procedure
Type: reference
Path: Procedure.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:based-on". -
SP_CATEGORY
Search parameter: categoryDescription: Classification of the procedure
Type: token
Path: Procedure.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Classification of the procedure
Type: token
Path: Procedure.category
-
SP_INSTANTIATES_CANONICAL
Search parameter: instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: Procedure.instantiatesCanonical
- See Also:
-
INSTANTIATES_CANONICAL
Fluent Client search parameter constant for instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: Procedure.instantiatesCanonical
-
INCLUDE_INSTANTIATES_CANONICAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:instantiates-canonical". -
SP_INSTANTIATES_URI
Search parameter: instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: Procedure.instantiatesUri
- See Also:
-
INSTANTIATES_URI
Fluent Client search parameter constant for instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: Procedure.instantiatesUri
-
SP_LOCATION
Search parameter: locationDescription: Where the procedure happened
Type: reference
Path: Procedure.location
- See Also:
-
LOCATION
Fluent Client search parameter constant for locationDescription: Where the procedure happened
Type: reference
Path: Procedure.location
-
INCLUDE_LOCATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:location". -
SP_PART_OF
Search parameter: part-ofDescription: Part of referenced event
Type: reference
Path: Procedure.partOf
- See Also:
-
PART_OF
Fluent Client search parameter constant for part-ofDescription: Part of referenced event
Type: reference
Path: Procedure.partOf
-
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:part-of". -
SP_PERFORMER
Search parameter: performerDescription: Who performed the procedure
Type: reference
Path: Procedure.performer.actor
- See Also:
-
PERFORMER
Fluent Client search parameter constant for performerDescription: Who performed the procedure
Type: reference
Path: Procedure.performer.actor
-
INCLUDE_PERFORMER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:performer". -
SP_REASON_CODE
Search parameter: reason-codeDescription: Reference to a concept (by class)
Type: token
Path: Procedure.reason.concept
- See Also:
-
REASON_CODE
Fluent Client search parameter constant for reason-codeDescription: Reference to a concept (by class)
Type: token
Path: Procedure.reason.concept
-
SP_REASON_REFERENCE
Search parameter: reason-referenceDescription: Reference to a resource (by instance)
Type: reference
Path: Procedure.reason.reference
- See Also:
-
REASON_REFERENCE
Fluent Client search parameter constant for reason-referenceDescription: Reference to a resource (by instance)
Type: reference
Path: Procedure.reason.reference
-
INCLUDE_REASON_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:reason-reference". -
SP_REPORT
Search parameter: reportDescription: Any report resulting from the procedure
Type: reference
Path: Procedure.report
- See Also:
-
REPORT
Fluent Client search parameter constant for reportDescription: Any report resulting from the procedure
Type: reference
Path: Procedure.report
-
INCLUDE_REPORT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:report". -
SP_STATUS
Search parameter: statusDescription: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Type: token
Path: Procedure.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown
Type: token
Path: Procedure.status
-
SP_SUBJECT
Search parameter: subjectDescription: Search by subject
Type: reference
Path: Procedure.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Search by subject
Type: reference
Path: Procedure.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:subject". -
SP_CODE
Search parameter: codeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure
Type: token
Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Code that identifies the allergy or intolerance [Condition](condition.html): Code for the condition [DeviceRequest](devicerequest.html): Code for what is being requested/ordered [DiagnosticReport](diagnosticreport.html): The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result [FamilyMemberHistory](familymemberhistory.html): A search by a condition code [List](list.html): What the purpose of this list is [Medication](medication.html): Returns medications for a specific code [MedicationAdministration](medicationadministration.html): Return administrations of this medication code [MedicationDispense](medicationdispense.html): Returns dispenses of this medicine code [MedicationRequest](medicationrequest.html): Return prescriptions of this medication code [MedicationUsage](medicationusage.html): Return statements of this medication code [Observation](observation.html): The code of the observation type [Procedure](procedure.html): A code to identify a procedure
Type: token
Path: AllergyIntolerance.code | AllergyIntolerance.reaction.substance | Condition.code | DeviceRequest.code.concept | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | MedicationAdministration.medication.concept | MedicationDispense.medication.concept | MedicationRequest.medication.concept | MedicationUsage.medication.concept | Observation.code | Procedure.code
-
SP_DATE
Search parameter: dateDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.as(dateTime) | DiagnosticReport.effective.as(Period) | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective.as(dateTime) | Observation.effective.as(Period) | Observation.effective.as(Timing) | Observation.effective.as(instant) | Procedure.occurrence.as(dateTime) | Procedure.occurrence.as(Period) | Procedure.occurrence.as(Timing) | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the actualPeriod the Encounter lasted [EpisodeOfCare](episodeofcare.html): The provided date search value falls within the episode of care's period [FamilyMemberHistory](familymemberhistory.html): When history was recorded or last updated [Flag](flag.html): Time period when flag is active [Immunization](immunization.html): Vaccination (non)-Administration Date [List](list.html): When the list was prepared [Observation](observation.html): Obtained date/time. If the obtained element is a period, a date that falls in the period [Procedure](procedure.html): When the procedure occurred or is occurring [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AllergyIntolerance.recordedDate | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.as(dateTime) | DiagnosticReport.effective.as(Period) | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective.as(dateTime) | Observation.effective.as(Period) | Observation.effective.as(Timing) | Observation.effective.as(instant) | Procedure.occurrence.as(dateTime) | Procedure.occurrence.as(Period) | Procedure.occurrence.as(Timing) | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
-
SP_ENCOUNTER
Search parameter: encounterDescription: Multiple Resources: [Composition](composition.html): Context of the Composition [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [Flag](flag.html): Alert relevant during encounter [List](list.html): Context in which list created [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Multiple Resources: [Composition](composition.html): Context of the Composition [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [Flag](flag.html): Alert relevant during encounter [List](list.html): Context in which list created [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: Composition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:encounter". -
SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): External ids for this item [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [Composition](composition.html): Version-independent identifier for the Composition [Condition](condition.html): A unique identifier of the condition record [Consent](consent.html): Identifier for this record (external references) [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentManifest](documentmanifest.html): Unique Identifier for the set of documents [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Goal](goal.html): External Ids for this goal [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [List](list.html): Business identifier [MedicationAdministration](medicationadministration.html): Return administrations with this external identifier [MedicationDispense](medicationdispense.html): Returns dispenses with this external identifier [MedicationRequest](medicationrequest.html): Return prescriptions with this external identifier [MedicationUsage](medicationusage.html): Return statements with this external identifier [NutritionOrder](nutritionorder.html): Return nutrition orders with this external identifier [Observation](observation.html): The unique id for a particular observation [Procedure](procedure.html): A unique identifier for a procedure [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: AllergyIntolerance.identifier | CarePlan.identifier | CareTeam.identifier | Composition.identifier | Condition.identifier | Consent.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DiagnosticReport.identifier | DocumentManifest.masterIdentifier | DocumentManifest.identifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationUsage.identifier | NutritionOrder.identifier | Observation.identifier | Procedure.identifier | RiskAssessment.identifier | ServiceRequest.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | VisionPrescription.identifier
-
SP_PATIENT
Search parameter: patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.subject | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | VisionPrescription.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Multiple Resources: [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ClinicalImpression](clinicalimpression.html): Patient assessed [Composition](composition.html): Who and/or what the composition is about [Condition](condition.html): Who has the condition? [Consent](consent.html): Who the consent applies to [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentManifest](documentmanifest.html): The subject of the set of documents [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [FamilyMemberHistory](familymemberhistory.html): The identity of a subject to list family member history items for [Flag](flag.html): The identity of a subject to list flags for [Goal](goal.html): Who this goal is intended for [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [List](list.html): If all resources have the same subject [MedicationAdministration](medicationadministration.html): The identity of a patient to list administrations for [MedicationDispense](medicationdispense.html): The identity of a patient to list dispenses for [MedicationRequest](medicationrequest.html): Returns prescriptions for a specific patient [MedicationUsage](medicationusage.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Procedure](procedure.html): Search by subject - a patient [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: AllergyIntolerance.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ClinicalImpression.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | DetectedIssue.subject | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentManifest.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EpisodeOfCare.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | List.subject.where(resolve() is Patient) | MedicationAdministration.subject.where(resolve() is Patient) | MedicationDispense.subject.where(resolve() is Patient) | MedicationRequest.subject.where(resolve() is Patient) | MedicationUsage.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | VisionPrescription.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:patient".
-
-
Constructor Details
-
Procedure
public Procedure()Constructor -
Procedure
Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Business identifiers assigned to this procedure by the performer or other systems which remain constant as the resource is updated and is propagated from server to server.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist {3}
-
getInstantiatesCanonical
- Returns:
instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.)
-
setInstantiatesCanonical
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesCanonical
-
addInstantiatesCanonicalElement
- Returns:
instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.)
-
addInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.)
-
hasInstantiatesCanonical
- Parameters:
value
-instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.)
-
getInstantiatesUri
- Returns:
instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.)
-
setInstantiatesUri
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasInstantiatesUri
-
addInstantiatesUriElement
- Returns:
instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.)
-
addInstantiatesUri
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.)
-
hasInstantiatesUri
- Parameters:
value
-instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, order set or other definition that is adhered to in whole or in part by this Procedure.)
-
getBasedOn
- Returns:
basedOn
(A reference to a resource that contains details of the request for this procedure.)
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn
, creating it if it does not already exist {3}
-
getPartOf
- Returns:
partOf
(A larger event of which this particular procedure is a component or step.)
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf
, creating it if it does not already exist {3}
-
getStatusElement
- Returns:
status
(A code specifying the state of the procedure. Generally, this will be the 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
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(A code specifying the state of the procedure. Generally, this will be the 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
- Returns:
- A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
-
setStatus
- Parameters:
value
- A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
-
getStatusReason
- Returns:
statusReason
(Captures the reason for the current state of the procedure.)
-
hasStatusReason
-
setStatusReason
- Parameters:
value
-statusReason
(Captures the reason for the current state of the procedure.)
-
getCategory
- Returns:
category
(A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").)
-
setCategory
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category
, creating it if it does not already exist {3}
-
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
-
setCode
- 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
- Returns:
subject
(On whom or on what the procedure was performed. This is usually an individual human, but can also be performed on animals, groups of humans or animals, organizations or practitioners (for licensing), locations or devices (for safety inspections or regulatory authorizations). If the actual focus of the procedure is different from the subject, the focus element specifies the actual focus of the procedure.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(On whom or on what the procedure was performed. This is usually an individual human, but can also be performed on animals, groups of humans or animals, organizations or practitioners (for licensing), locations or devices (for safety inspections or regulatory authorizations). If the actual focus of the procedure is different from the subject, the focus element specifies the actual focus of the procedure.)
-
getFocus
- Returns:
focus
(Who is the target of the procedure when it is not the subject of record only. If focus is not present, then subject is the focus. If focus is present and the subject is one of the targets of the procedure, include subject as a focus as well. If focus is present and the subject is not included in focus, it implies that the procedure was only targeted on the focus. For example, when a caregiver is given education for a patient, the caregiver would be the focus and the procedure record is associated with the subject (e.g. patient). For example, use focus when recording the target of the education, training, or counseling is the parent or relative of a patient.)
-
hasFocus
-
setFocus
- Parameters:
value
-focus
(Who is the target of the procedure when it is not the subject of record only. If focus is not present, then subject is the focus. If focus is present and the subject is one of the targets of the procedure, include subject as a focus as well. If focus is present and the subject is not included in focus, it implies that the procedure was only targeted on the focus. For example, when a caregiver is given education for a patient, the caregiver would be the focus and the procedure record is associated with the subject (e.g. patient). For example, use focus when recording the target of the education, training, or counseling is the parent or relative of a patient.)
-
getEncounter
- Returns:
encounter
(The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.)
-
getOccurrence
- Returns:
occurrence
(Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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.)
-
getOccurrenceDateTimeType
- Returns:
occurrence
(Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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
-
hasOccurrenceDateTimeType
-
getOccurrencePeriod
- Returns:
occurrence
(Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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
-
hasOccurrencePeriod
-
getOccurrenceStringType
- Returns:
occurrence
(Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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
-
hasOccurrenceStringType
-
getOccurrenceAge
- Returns:
occurrence
(Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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
-
hasOccurrenceAge
-
getOccurrenceRange
- Returns:
occurrence
(Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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
-
hasOccurrenceRange
-
getOccurrenceTiming
- Returns:
occurrence
(Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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
-
hasOccurrenceTiming
-
hasOccurrence
-
setOccurrence
- Parameters:
value
-occurrence
(Estimated or actual date, date-time, period, or age when the procedure did occur or is occurring. 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.)
-
getRecordedElement
- Returns:
recorded
(The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
hasRecordedElement
-
hasRecorded
-
setRecordedElement
- Parameters:
value
-recorded
(The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).). This is the underlying object with id, value and extensions. The accessor "getRecorded" gives direct access to the value
-
getRecorded
- Returns:
- The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).
-
setRecorded
- Parameters:
value
- The date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).
-
getRecorder
- Returns:
recorder
(Individual who recorded the record and takes responsibility for its content.)
-
hasRecorder
-
setRecorder
- Parameters:
value
-recorder
(Individual who recorded the record and takes responsibility for its content.)
-
getReported
- Returns:
reported
(Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.)
-
getReportedBooleanType
- Returns:
reported
(Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasReportedBooleanType
-
getReportedReference
- Returns:
reported
(Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasReportedReference
-
hasReported
-
setReported
- Parameters:
value
-reported
(Indicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record. It may also indicate the source of the report.)
-
getPerformer
- Returns:
performer
(Limited to "real" people rather than equipment.)
-
setPerformer
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasPerformer
-
addPerformer
-
addPerformer
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
performer
, creating it if it does not already exist {3}
-
getLocation
- Returns:
location
(The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)
-
hasLocation
-
setLocation
- Parameters:
value
-location
(The location where the procedure actually happened. E.g. a newborn at home, a tracheostomy at a restaurant.)
-
getReason
- Returns:
reason
(The coded reason or reference why the procedure was performed. This may be a coded entity of some type, be present as text, or be a reference to one of several resources that justify the procedure.)
-
setReason
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReason
-
addReason
-
addReason
-
getReasonFirstRep
- Returns:
- The first repetition of repeating field
reason
, creating it if it does not already exist {3}
-
getBodySite
- Returns:
bodySite
(Detailed and structured anatomical location information. Multiple locations are allowed - e.g. multiple punch biopsies of a lesion.)
-
setBodySite
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasBodySite
-
addBodySite
-
addBodySite
-
getBodySiteFirstRep
- Returns:
- The first repetition of repeating field
bodySite
, creating it if it does not already exist {3}
-
getOutcome
- Returns:
outcome
(The outcome of the procedure - did it resolve the reasons for the procedure being performed?)
-
hasOutcome
-
setOutcome
- Parameters:
value
-outcome
(The outcome of the procedure - did it resolve the reasons for the procedure being performed?)
-
getReport
- Returns:
report
(This could be a histology result, pathology report, surgical report, etc.)
-
setReport
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasReport
-
addReport
-
addReport
-
getReportFirstRep
- Returns:
- The first repetition of repeating field
report
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasComplication
-
addComplication
-
addComplication
-
getComplicationFirstRep
- Returns:
- The first repetition of repeating field
complication
, creating it if it does not already exist {3}
-
getFollowUp
- Returns:
followUp
(If the procedure required specific follow up - e.g. removal of sutures. The follow up may be represented as a simple note or could potentially be more complex, in which case the CarePlan resource can be used.)
-
setFollowUp
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasFollowUp
-
addFollowUp
-
addFollowUp
-
getFollowUpFirstRep
- Returns:
- The first repetition of repeating field
followUp
, creating it if it does not already exist {3}
-
getNote
- Returns:
note
(Any other notes and comments about the procedure.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist {3}
-
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
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasFocalDevice
-
addFocalDevice
-
addFocalDevice
-
getFocalDeviceFirstRep
- Returns:
- The first repetition of repeating field
focalDevice
, creating it if it does not already exist {3}
-
getUsed
- Returns:
used
(Identifies medications, devices and any other substance used as part of the procedure.)
-
setUsed
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasUsed
-
addUsed
-
addUsed
-
getUsedFirstRep
- Returns:
- The first repetition of repeating field
used
, creating it if it does not already exist {3}
-
getSupportingInfo
- Returns:
supportingInfo
(Other resources from the patient record that may be relevant to the procedure. The information from these resources was either used to create the instance or is provided to help with its interpretation. This extension should not be used if more specific inline elements or extensions are available.)
-
setSupportingInfo
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasSupportingInfo
-
addSupportingInfo
-
addSupportingInfo
-
getSupportingInfoFirstRep
- Returns:
- The first repetition of repeating field
supportingInfo
, creating it if it does not already exist {3}
-
listChildren
- 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
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- 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
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-