Class Procedure
- java.lang.Object
-
- org.hl7.fhir.r5.model.Base
-
- org.hl7.fhir.r5.model.BaseResource
-
- org.hl7.fhir.r5.model.Resource
-
- org.hl7.fhir.r5.model.DomainResource
-
- org.hl7.fhir.r5.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 or for a patient, practitioner, device, organization, or location. For example, this can be a physical intervention on a patient like an operation, or less invasive like long term services, counseling, or hypnotherapy. This can be a quality or safety inspection for a location, organization, or device. This can be an accreditation procedure on a practitioner for licensing.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classProcedure.ProcedureFocalDeviceComponentstatic classProcedure.ProcedurePerformerComponent
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.ReferenceClientParamBASED_ONFluent Client search parameter constant for based-onprotected List<Reference>basedOnA reference to a resource that contains details of the request for this procedure.protected List<CodeableConcept>bodySiteDetailed and structured anatomical location information.protected List<CodeableConcept>categoryA code that classifies the procedure for searching, sorting and display purposes (e.g.static ca.uhn.fhir.rest.gclient.TokenClientParamCATEGORYFluent Client search parameter constant for categoryprotected CodeableConceptcodeThe specific procedure that is performed.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected List<CodeableConcept>complicationAny complications that occurred during the procedure, or in the immediate post-performance period.protected List<Reference>complicationDetailAny complications that occurred during the procedure, or in the immediate post-performance period.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected ReferenceencounterThe Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENCOUNTERFluent Client search parameter constant for encounterprotected List<Procedure.ProcedureFocalDeviceComponent>focalDeviceA 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>followUpIf the procedure required specific follow up - e.g.protected List<Identifier>identifierBusiness 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 ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_BASED_ONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ENCOUNTERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_INSTANTIATES_CANONICALConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_LOCATIONConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PART_OFConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PATIENTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_PERFORMERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REASON_REFERENCEConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_REPORTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_SUBJECTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINSTANTIATES_CANONICALFluent Client search parameter constant for instantiates-canonicalstatic ca.uhn.fhir.rest.gclient.UriClientParamINSTANTIATES_URIFluent Client search parameter constant for instantiates-uriprotected List<CanonicalType>instantiatesCanonicalThe 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.protected List<UriType>instantiatesUriThe 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 ReferencelocationThe location where the procedure actually happened.static ca.uhn.fhir.rest.gclient.ReferenceClientParamLOCATIONFluent Client search parameter constant for locationprotected List<Annotation>noteAny other notes and comments about the procedure.protected DataTypeoccurrenceEstimated or actual date, date-time, period, or age when the procedure did occur or is occurring.protected CodeableConceptoutcomeThe outcome of the procedure - did it resolve the reasons for the procedure being performed?static ca.uhn.fhir.rest.gclient.ReferenceClientParamPART_OFFluent Client search parameter constant for part-ofprotected List<Reference>partOfA larger event of which this particular procedure is a component or step.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected List<Procedure.ProcedurePerformerComponent>performerLimited to "real" people rather than equipment.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPERFORMERFluent Client search parameter constant for performerprotected List<CodeableReference>reasonThe coded reason or reference why the procedure was performed.static ca.uhn.fhir.rest.gclient.TokenClientParamREASON_CODEFluent Client search parameter constant for reason-codestatic ca.uhn.fhir.rest.gclient.ReferenceClientParamREASON_REFERENCEFluent Client search parameter constant for reason-referenceprotected DateTimeTyperecordedThe date the occurrence of the procedure was first captured in the record regardless of Procedure.status (potentially after the occurrence of the event).protected ReferencerecorderIndividual who recorded the record and takes responsibility for its content.protected List<Reference>reportThis could be a histology result, pathology report, surgical report, etc.static ca.uhn.fhir.rest.gclient.ReferenceClientParamREPORTFluent Client search parameter constant for reportprotected DataTypereportedIndicates if this record was captured as a secondary 'reported' record rather than as an original primary source-of-truth record.static StringSP_BASED_ONSearch parameter: based-onstatic StringSP_CATEGORYSearch parameter: categorystatic StringSP_CODESearch parameter: codestatic StringSP_DATESearch parameter: datestatic StringSP_ENCOUNTERSearch parameter: encounterstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INSTANTIATES_CANONICALSearch parameter: instantiates-canonicalstatic StringSP_INSTANTIATES_URISearch parameter: instantiates-uristatic StringSP_LOCATIONSearch parameter: locationstatic StringSP_PART_OFSearch parameter: part-ofstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_PERFORMERSearch parameter: performerstatic StringSP_REASON_CODESearch parameter: reason-codestatic StringSP_REASON_REFERENCESearch parameter: reason-referencestatic StringSP_REPORTSearch parameter: reportstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectprotected Enumeration<Enumerations.EventStatus>statusA code specifying the state of the procedure.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected CodeableConceptstatusReasonCaptures the reason for the current state of the procedure.protected ReferencesubjectOn whom or what the procedure was performed.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected List<Reference>supportingInfoOther resources from the patient record that may be relevant to the procedure.protected List<CodeableReference>usedIdentifies 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
-
-
Constructor Summary
Constructors Constructor Description Procedure()ConstructorProcedure(Enumerations.EventStatus status, Reference subject)Constructor
-
Method Summary
-
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, getImplicitRules, getImplicitRulesElement, getLanguage, 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.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r5.model.Base
children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyUserData, copyValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getXhtml, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, isDateTime, 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
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
protected List<CanonicalType> 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
protected List<UriType> 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
protected List<Reference> basedOn
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.
-
status
protected Enumeration<Enumerations.EventStatus> status
A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
-
statusReason
protected CodeableConcept statusReason
Captures the reason for the current state of the procedure.
-
category
protected List<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
On whom or 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).
-
encounter
protected Reference encounter
The Encounter during which this Procedure was created or performed or to which the creation of this record is tightly associated.
-
occurrence
protected DataType 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
protected DateTimeType 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
protected Reference recorder
Individual who recorded the record and takes responsibility for its content.
-
reported
protected DataType 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
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.
-
reason
protected List<CodeableReference> reason
The coded reason or reference why the procedure was performed. This may be a coded entity of some type, or may simply be present as text, or may be a reference to one of several resources that justify the procedure.
-
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 the reasons for the procedure being performed?
-
report
protected List<Reference> report
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.
-
followUp
protected List<CodeableConcept> 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
protected List<Annotation> note
Any other notes and comments about the procedure.
-
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.
-
used
protected List<CodeableReference> used
Identifies medications, devices and any other substance used as part of the procedure.
-
supportingInfo
protected List<Reference> 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
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_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_INSTANTIATES_CANONICAL
public static final String SP_INSTANTIATES_CANONICAL
Search parameter: instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: Procedure.instantiatesCanonical
- See Also:
- Constant Field Values
-
INSTANTIATES_CANONICAL
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INSTANTIATES_CANONICAL
Fluent Client search parameter constant for instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: Procedure.instantiatesCanonical
-
INCLUDE_INSTANTIATES_CANONICAL
public static final ca.uhn.fhir.model.api.Include 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
public static final String SP_INSTANTIATES_URI
Search parameter: instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: Procedure.instantiatesUri
- See Also:
- Constant Field Values
-
INSTANTIATES_URI
public static final ca.uhn.fhir.rest.gclient.UriClientParam INSTANTIATES_URI
Fluent Client search parameter constant for instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: Procedure.instantiatesUri
-
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_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_PERFORMER
public static final String SP_PERFORMER
Search parameter: performerDescription: Who performed the procedure
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: Who performed the procedure
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_REASON_CODE
public static final String SP_REASON_CODE
Search parameter: reason-codeDescription: Reference to a concept (by class)
Type: token
Path: Procedure.reason.concept
- See Also:
- Constant Field Values
-
REASON_CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
public static final String SP_REASON_REFERENCE
Search parameter: reason-referenceDescription: Reference to a resource (by instance)
Type: reference
Path: Procedure.reason.reference
- See Also:
- Constant Field Values
-
REASON_REFERENCE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_REASON_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:reason-reference".
-
SP_REPORT
public static final String SP_REPORT
Search parameter: reportDescription: Any report resulting from the procedure
Type: reference
Path: Procedure.report
- See Also:
- Constant Field Values
-
REPORT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam REPORT
Fluent Client search parameter constant for reportDescription: Any report resulting from the procedure
Type: reference
Path: Procedure.report
-
INCLUDE_REPORT
public static final ca.uhn.fhir.model.api.Include INCLUDE_REPORT
Constant for fluent queries to be used to add include statements. Specifies the path value of "Procedure:report".
-
SP_STATUS
public static final String 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:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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
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_CODE
public static final String 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 [ServiceRequest](servicerequest.html): What is being requested/ordered
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 | ServiceRequest.code
- See Also:
- Constant Field Values
-
CODE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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 [ServiceRequest](servicerequest.html): What is being requested/ordered
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 | ServiceRequest.code
-
SP_DATE
public static final String 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.dateTime | DiagnosticReport.effective | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam 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.dateTime | DiagnosticReport.effective | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence as dateTime) | List.date | Observation.effective | Procedure.occurrence | (RiskAssessment.occurrence as dateTime) | SupplyRequest.authoredOn
-
SP_ENCOUNTER
public static final String 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 [DocumentReference](documentreference.html): Context of the document content [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 | DocumentReference.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter
- See Also:
- Constant Field Values
-
ENCOUNTER
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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 [DocumentReference](documentreference.html): Context of the document content [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 | DocumentReference.encounter | Flag.encounter | List.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | RiskAssessment.encounter | ServiceRequest.encounter | VisionPrescription.encounter
-
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_IDENTIFIER
public static final String 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.content.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:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam 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.content.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
public static final String 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 person 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 [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.patient | 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.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 | VisionPrescription.patient
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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 person 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 [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.patient | 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.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 | VisionPrescription.patient
-
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".
-
-
Constructor Detail
-
Procedure
public Procedure()
Constructor
-
Procedure
public Procedure(Enumerations.EventStatus status, Reference subject)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> 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
public Procedure setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor 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 {3}
-
getInstantiatesCanonical
public List<CanonicalType> 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
public Procedure setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiatesCanonical
public boolean hasInstantiatesCanonical()
-
addInstantiatesCanonicalElement
public CanonicalType 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
public Procedure addInstantiatesCanonical(String value)
- 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
public boolean hasInstantiatesCanonical(String value)
- 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
public List<UriType> 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
public Procedure setInstantiatesUri(List<UriType> theInstantiatesUri)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiatesUri
public boolean hasInstantiatesUri()
-
addInstantiatesUriElement
public UriType 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
public Procedure addInstantiatesUri(String value)
- 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
public boolean hasInstantiatesUri(String value)
- 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
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
thisfor 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 {3}
-
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
thisfor 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 {3}
-
getStatusElement
public Enumeration<Enumerations.EventStatus> 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
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public Procedure setStatusElement(Enumeration<Enumerations.EventStatus> value)
- 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
public Enumerations.EventStatus getStatus()
- Returns:
- A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
-
setStatus
public Procedure setStatus(Enumerations.EventStatus value)
- Parameters:
value- A code specifying the state of the procedure. Generally, this will be the in-progress or completed state.
-
getStatusReason
public CodeableConcept getStatusReason()
- Returns:
statusReason(Captures the reason for the current state of the procedure.)
-
hasStatusReason
public boolean hasStatusReason()
-
setStatusReason
public Procedure setStatusReason(CodeableConcept value)
- Parameters:
value-statusReason(Captures the reason for the current state of the procedure.)
-
getCategory
public List<CodeableConcept> getCategory()
- Returns:
category(A code that classifies the procedure for searching, sorting and display purposes (e.g. "Surgical Procedure").)
-
setCategory
public Procedure setCategory(List<CodeableConcept> theCategory)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
public boolean hasCategory()
-
addCategory
public CodeableConcept addCategory()
-
addCategory
public Procedure addCategory(CodeableConcept t)
-
getCategoryFirstRep
public CodeableConcept getCategoryFirstRep()
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist {3}
-
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(On whom or 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).)
-
hasSubject
public boolean hasSubject()
-
setSubject
public Procedure setSubject(Reference value)
- Parameters:
value-subject(On whom or 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).)
-
getEncounter
public Reference 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
public boolean hasEncounter()
-
setEncounter
public Procedure setEncounter(Reference value)
- 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
public DataType 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
public DateTimeType getOccurrenceDateTimeType() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasOccurrenceDateTimeType()
-
getOccurrencePeriod
public Period getOccurrencePeriod() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasOccurrencePeriod()
-
getOccurrenceStringType
public StringType getOccurrenceStringType() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasOccurrenceStringType()
-
getOccurrenceAge
public Age getOccurrenceAge() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasOccurrenceAge()
-
getOccurrenceRange
public Range getOccurrenceRange() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasOccurrenceRange()
-
getOccurrenceTiming
public Timing getOccurrenceTiming() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasOccurrenceTiming()
-
hasOccurrence
public boolean hasOccurrence()
-
setOccurrence
public Procedure setOccurrence(DataType value)
- 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
public DateTimeType 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
public boolean hasRecordedElement()
-
hasRecorded
public boolean hasRecorded()
-
setRecordedElement
public Procedure setRecordedElement(DateTimeType value)
- 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
public Date 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
public Procedure setRecorded(Date value)
- 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
public Reference getRecorder()
- Returns:
recorder(Individual who recorded the record and takes responsibility for its content.)
-
hasRecorder
public boolean hasRecorder()
-
setRecorder
public Procedure setRecorder(Reference value)
- Parameters:
value-recorder(Individual who recorded the record and takes responsibility for its content.)
-
getReported
public DataType 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
public BooleanType getReportedBooleanType() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasReportedBooleanType()
-
getReportedReference
public Reference getReportedReference() throws org.hl7.fhir.exceptions.FHIRException
- 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
public boolean hasReportedReference()
-
hasReported
public boolean hasReported()
-
setReported
public Procedure setReported(DataType value)
- 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
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
thisfor 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 {3}
-
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.)
-
getReason
public List<CodeableReference> getReason()
- Returns:
reason(The coded reason or reference why the procedure was performed. This may be a coded entity of some type, or may simply be present as text, or may be a reference to one of several resources that justify the procedure.)
-
setReason
public Procedure setReason(List<CodeableReference> theReason)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReason
public boolean hasReason()
-
addReason
public CodeableReference addReason()
-
addReason
public Procedure addReason(CodeableReference t)
-
getReasonFirstRep
public CodeableReference getReasonFirstRep()
- Returns:
- The first repetition of repeating field
reason, creating it if it does not already exist {3}
-
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
thisfor 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 {3}
-
getOutcome
public CodeableConcept getOutcome()
- Returns:
outcome(The outcome of the procedure - did it resolve the 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 the 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
thisfor 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 {3}
-
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
thisfor 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 {3}
-
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
thisfor 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 {3}
-
getFollowUp
public List<CodeableConcept> 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
public Procedure setFollowUp(List<CodeableConcept> theFollowUp)
- Returns:
- Returns a reference to
thisfor 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 {3}
-
getNote
public List<Annotation> getNote()
- Returns:
note(Any other notes and comments about the procedure.)
-
setNote
public Procedure setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor 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 {3}
-
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
thisfor 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 {3}
-
getUsed
public List<CodeableReference> getUsed()
- Returns:
used(Identifies medications, devices and any other substance used as part of the procedure.)
-
setUsed
public Procedure setUsed(List<CodeableReference> theUsed)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasUsed
public boolean hasUsed()
-
addUsed
public CodeableReference addUsed()
-
addUsed
public Procedure addUsed(CodeableReference t)
-
getUsedFirstRep
public CodeableReference getUsedFirstRep()
- Returns:
- The first repetition of repeating field
used, creating it if it does not already exist {3}
-
getSupportingInfo
public List<Reference> 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
public Procedure setSupportingInfo(List<Reference> theSupportingInfo)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInfo
public boolean hasSupportingInfo()
-
addSupportingInfo
public Reference addSupportingInfo()
-
addSupportingInfo
public Procedure addSupportingInfo(Reference t)
-
getSupportingInfoFirstRep
public Reference getSupportingInfoFirstRep()
- Returns:
- The first repetition of repeating field
supportingInfo, creating it if it does not already exist {3}
-
listChildren
protected void listChildren(List<Property> children)
- Overrides:
listChildrenin classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makePropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource
-
copy
public Procedure copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(Procedure dst)
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceTypein classResource
-
-