
Package org.hl7.fhir.r5.patterns
Interface Event
- All Superinterfaces:
PatternBase
A pattern to be followed by resources that represent the performance of some activity, possibly in accordance with a request or service definition.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
static enum
static class
-
Method Summary
Modifier and TypeMethodDescriptionaddInstantiatesCanonical
(String value) addInstantiatesUri
(String value) addNote()
fhirType()
int
int
getCode()
int
int
int
int
int
int
int
int
int
int
int
int
getNote()
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
int
boolean
boolean
hasCode()
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
setBasedOn
(List<Reference> theBasedOn) setCode
(CodeableConcept value) setEncounter
(Reference value) setIdentifier
(List<Identifier> theIdentifier) setInstantiatesCanonical
(List<CanonicalType> theInstantiatesCanonical) setInstantiatesUri
(List<UriType> theInstantiatesUri) setLocation
(Reference value) setNote
(List<Annotation> theNote) setOccurrence
(DataType value) setPerformer
(List<Event.EventPerformerComponent> thePerformer) setReasonCode
(List<CodeableConcept> theReasonCode) setReasonReference
(List<Reference> theReasonReference) setRecorded
(Date value) setRecordedElement
(DateTimeType value) setReported
(DataType value) setResearchStudy
(List<Reference> theResearchStudy) setStatus
(Event.EventStatus value) setStatusReason
(CodeableConcept value) setSubject
(Reference value) Methods inherited from interface org.hl7.fhir.r5.patterns.PatternBase
getExtension, getId, setId
-
Method Details
-
getIdentifier
- Returns:
#identifier
(Business identifiers assigned to this {{title}} by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasIdentifier
boolean hasIdentifier()- Returns:
- whether there is more than zero values for identifier
-
getIdentifierMin
int getIdentifierMin()- Returns:
- minimum allowed cardinality for identifier. Note that with patterns, this may be different for the underlying resource
-
getIdentifierMax
int getIdentifierMax()- Returns:
- maximum allowed cardinality for identifier. Note that with patterns, this may be different for the underlying resource
-
addIdentifier
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addIdentifier
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
#identifier
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getInstantiatesCanonical
- Returns:
#instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setInstantiatesCanonical
Event setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical) throws org.hl7.fhir.exceptions.FHIRException - Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasInstantiatesCanonical
boolean hasInstantiatesCanonical()- Returns:
- whether there is more than zero values for instantiatesCanonical
-
getInstantiatesCanonicalMin
- Returns:
- minimum allowed cardinality for instantiatesCanonical. Note that with patterns, this may be different for the underlying resource
-
getInstantiatesCanonicalMax
- Returns:
- maximum allowed cardinality for instantiatesCanonical. Note that with patterns, this may be different for the underlying resource
-
addInstantiatesCanonicalElement
- Returns:
#instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addInstantiatesCanonical
- Parameters:
value
-#instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasInstantiatesCanonical
- Parameters:
value
-#instantiatesCanonical
(The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getInstantiatesUri
- Returns:
#instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setInstantiatesUri
Event setInstantiatesUri(List<UriType> theInstantiatesUri) throws org.hl7.fhir.exceptions.FHIRException - Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasInstantiatesUri
boolean hasInstantiatesUri()- Returns:
- whether there is more than zero values for instantiatesUri
-
getInstantiatesUriMin
int getInstantiatesUriMin()- Returns:
- minimum allowed cardinality for instantiatesUri. Note that with patterns, this may be different for the underlying resource
-
getInstantiatesUriMax
int getInstantiatesUriMax()- Returns:
- maximum allowed cardinality for instantiatesUri. Note that with patterns, this may be different for the underlying resource
-
addInstantiatesUriElement
- Returns:
#instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addInstantiatesUri
- Parameters:
value
-#instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasInstantiatesUri
- Parameters:
value
-#instantiatesUri
(The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getBasedOn
- Returns:
#basedOn
(A plan, proposal or order that is fulfilled in whole or in part by this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setBasedOn
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasBasedOn
boolean hasBasedOn()- Returns:
- whether there is more than zero values for basedOn
-
getBasedOnMin
int getBasedOnMin()- Returns:
- minimum allowed cardinality for basedOn. Note that with patterns, this may be different for the underlying resource
-
getBasedOnMax
int getBasedOnMax()- Returns:
- maximum allowed cardinality for basedOn. Note that with patterns, this may be different for the underlying resource
-
addBasedOn
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addBasedOn
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
#basedOn
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getPartOf
- Returns:
#partOf
(A larger event of which this particular {{title}} is a component or step.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setPartOf
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasPartOf
boolean hasPartOf()- Returns:
- whether there is more than zero values for partOf
-
getPartOfMin
int getPartOfMin()- Returns:
- minimum allowed cardinality for partOf. Note that with patterns, this may be different for the underlying resource
-
getPartOfMax
int getPartOfMax()- Returns:
- maximum allowed cardinality for partOf. Note that with patterns, this may be different for the underlying resource
-
addPartOf
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addPartOf
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
#partOf
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getResearchStudy
- Returns:
#researchStudy
(Indicates that this {{title}} is relevant to the specified research study(ies).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setResearchStudy
Event setResearchStudy(List<Reference> theResearchStudy) throws org.hl7.fhir.exceptions.FHIRException - Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasResearchStudy
boolean hasResearchStudy()- Returns:
- whether there is more than zero values for researchStudy
-
getResearchStudyMin
int getResearchStudyMin()- Returns:
- minimum allowed cardinality for researchStudy. Note that with patterns, this may be different for the underlying resource
-
getResearchStudyMax
int getResearchStudyMax()- Returns:
- maximum allowed cardinality for researchStudy. Note that with patterns, this may be different for the underlying resource
-
addResearchStudy
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addResearchStudy
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getResearchStudyFirstRep
- Returns:
- The first repetition of repeating field
#researchStudy
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getStatusElement
- Returns:
#status
(The current state of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStatus
boolean hasStatus()- Returns:
- whether there is more than zero values for status
-
getStatusMin
- Returns:
- minimum allowed cardinality for status. Note that with patterns, this may be different for the underlying resource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getStatusMax
- Returns:
- maximum allowed cardinality for status. Note that with patterns, this may be different for the underlying resource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStatusElement
boolean hasStatusElement() -
setStatusElement
Event setStatusElement(Enumeration<Event.EventStatus> value) throws org.hl7.fhir.exceptions.FHIRException - Parameters:
value
-#status
(The current state of the {{title}}.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getStatus
- Returns:
- The current state of the {{title}}.
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setStatus
- Parameters:
value
- The current state of the {{title}}.- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getStatusReason
- Returns:
#statusReason
(Captures the reason for the current state of the {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasStatusReason
boolean hasStatusReason()- Returns:
- whether there is more than zero values for statusReason
-
getStatusReasonMin
int getStatusReasonMin()- Returns:
- minimum allowed cardinality for statusReason. Note that with patterns, this may be different for the underlying resource
-
getStatusReasonMax
int getStatusReasonMax()- Returns:
- maximum allowed cardinality for statusReason. Note that with patterns, this may be different for the underlying resource
-
setStatusReason
- Parameters:
value
-#statusReason
(Captures the reason for the current state of the {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getCode
- Returns:
#code
(A code that identifies the specific service or action that was or is being performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasCode
boolean hasCode()- Returns:
- whether there is more than zero values for code
-
getCodeMin
int getCodeMin()- Returns:
- minimum allowed cardinality for code. Note that with patterns, this may be different for the underlying resource
-
getCodeMax
int getCodeMax()- Returns:
- maximum allowed cardinality for code. Note that with patterns, this may be different for the underlying resource
-
setCode
- Parameters:
value
-#code
(A code that identifies the specific service or action that was or is being performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getSubject
- Returns:
#subject
(The individual or set of individuals the action is being or was performed on.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSubject
boolean hasSubject()- Returns:
- whether there is more than zero values for subject
-
getSubjectMin
int getSubjectMin()- Returns:
- minimum allowed cardinality for subject. Note that with patterns, this may be different for the underlying resource
-
getSubjectMax
int getSubjectMax()- Returns:
- maximum allowed cardinality for subject. Note that with patterns, this may be different for the underlying resource
-
setSubject
- Parameters:
value
-#subject
(The individual or set of individuals the action is being or was performed on.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getEncounter
- Returns:
#encounter
(The Encounter during which this {{title}} was created or to which the creation of this record is tightly associated.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasEncounter
boolean hasEncounter()- Returns:
- whether there is more than zero values for encounter
-
getEncounterMin
int getEncounterMin()- Returns:
- minimum allowed cardinality for encounter. Note that with patterns, this may be different for the underlying resource
-
getEncounterMax
int getEncounterMax()- Returns:
- maximum allowed cardinality for encounter. Note that with patterns, this may be different for the underlying resource
-
setEncounter
- Parameters:
value
-#encounter
(The Encounter during which this {{title}} was created or to which the creation of this record is tightly associated.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getOccurrence
- Returns:
#occurrence
(The date, period or timing when the {{title}} did occur or is occurring.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getOccurrenceDateTimeType
- Returns:
#occurrence
(The date, period or timing when the {{title}} did occur or is occurring.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceDateTimeType
boolean hasOccurrenceDateTimeType() -
getOccurrencePeriod
- Returns:
#occurrence
(The date, period or timing when the {{title}} did occur or is occurring.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrencePeriod
boolean hasOccurrencePeriod() -
getOccurrenceTiming
- Returns:
#occurrence
(The date, period or timing when the {{title}} did occur or is occurring.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasOccurrenceTiming
boolean hasOccurrenceTiming() -
hasOccurrence
boolean hasOccurrence()- Returns:
- whether there is more than zero values for occurrence
-
getOccurrenceMin
int getOccurrenceMin()- Returns:
- minimum allowed cardinality for occurrence. Note that with patterns, this may be different for the underlying resource
-
getOccurrenceMax
int getOccurrenceMax()- Returns:
- maximum allowed cardinality for occurrence. Note that with patterns, this may be different for the underlying resource
-
setOccurrence
- Parameters:
value
-#occurrence
(The date, period or timing when the {{title}} did occur or is occurring.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getRecordedElement
- Returns:
#recorded
(The date the occurrence of the {{title}} was first captured in the record - potentially significantly 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- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasRecorded
boolean hasRecorded()- Returns:
- whether there is more than zero values for recorded
-
getRecordedMin
- Returns:
- minimum allowed cardinality for recorded. Note that with patterns, this may be different for the underlying resource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getRecordedMax
- Returns:
- maximum allowed cardinality for recorded. Note that with patterns, this may be different for the underlying resource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasRecordedElement
boolean hasRecordedElement() -
setRecordedElement
- Parameters:
value
-#recorded
(The date the occurrence of the {{title}} was first captured in the record - potentially significantly 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- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getRecorded
- Returns:
- The date the occurrence of the {{title}} was first captured in the record - potentially significantly after the occurrence of the event.
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setRecorded
- Parameters:
value
- The date the occurrence of the {{title}} was first captured in the record - potentially significantly after the occurrence of the event.- Throws:
org.hl7.fhir.exceptions.FHIRException
-
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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
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
boolean 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
boolean hasReportedReference() -
hasReported
boolean hasReported()- Returns:
- whether there is more than zero values for reported
-
getReportedMin
int getReportedMin()- Returns:
- minimum allowed cardinality for reported. Note that with patterns, this may be different for the underlying resource
-
getReportedMax
int getReportedMax()- Returns:
- maximum allowed cardinality for reported. Note that with patterns, this may be different for the underlying resource
-
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.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getPerformer
- Returns:
#performer
(Indicates who or what performed the {{title}} and how they were involved.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setPerformer
Event setPerformer(List<Event.EventPerformerComponent> thePerformer) throws org.hl7.fhir.exceptions.FHIRException - Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasPerformer
boolean hasPerformer()- Returns:
- whether there is more than zero values for performer
-
getPerformerMin
int getPerformerMin()- Returns:
- minimum allowed cardinality for performer. Note that with patterns, this may be different for the underlying resource
-
getPerformerMax
int getPerformerMax()- Returns:
- maximum allowed cardinality for performer. Note that with patterns, this may be different for the underlying resource
-
addPerformer
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addPerformer
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getPerformerFirstRep
- Returns:
- The first repetition of repeating field
#performer
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getLocation
- Returns:
#location
(The principal physical location where the {{title}} was performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasLocation
boolean hasLocation()- Returns:
- whether there is more than zero values for location
-
getLocationMin
int getLocationMin()- Returns:
- minimum allowed cardinality for location. Note that with patterns, this may be different for the underlying resource
-
getLocationMax
int getLocationMax()- Returns:
- maximum allowed cardinality for location. Note that with patterns, this may be different for the underlying resource
-
setLocation
- Parameters:
value
-#location
(The principal physical location where the {{title}} was performed.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getReasonCode
- Returns:
#reasonCode
(Describes why the {{title}} occurred in coded or textual form.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setReasonCode
Event setReasonCode(List<CodeableConcept> theReasonCode) throws org.hl7.fhir.exceptions.FHIRException - Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasReasonCode
boolean hasReasonCode()- Returns:
- whether there is more than zero values for reasonCode
-
getReasonCodeMin
int getReasonCodeMin()- Returns:
- minimum allowed cardinality for reasonCode. Note that with patterns, this may be different for the underlying resource
-
getReasonCodeMax
int getReasonCodeMax()- Returns:
- maximum allowed cardinality for reasonCode. Note that with patterns, this may be different for the underlying resource
-
addReasonCode
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addReasonCode
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getReasonCodeFirstRep
- Returns:
- The first repetition of repeating field
#reasonCode
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getReasonReference
- Returns:
#reasonReference
(Indicates another resource whose existence justifies this {{title}}.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setReasonReference
Event setReasonReference(List<Reference> theReasonReference) throws org.hl7.fhir.exceptions.FHIRException - Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasReasonReference
boolean hasReasonReference()- Returns:
- whether there is more than zero values for reasonReference
-
getReasonReferenceMin
int getReasonReferenceMin()- Returns:
- minimum allowed cardinality for reasonReference. Note that with patterns, this may be different for the underlying resource
-
getReasonReferenceMax
int getReasonReferenceMax()- Returns:
- maximum allowed cardinality for reasonReference. Note that with patterns, this may be different for the underlying resource
-
addReasonReference
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addReasonReference
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getReasonReferenceFirstRep
- Returns:
- The first repetition of repeating field
#reasonReference
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getNote
- Returns:
#note
(Comments made about the {{title}} by the performer, subject or other participants.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasNote
boolean hasNote()- Returns:
- whether there is more than zero values for note
-
getNoteMin
int getNoteMin()- Returns:
- minimum allowed cardinality for note. Note that with patterns, this may be different for the underlying resource
-
getNoteMax
int getNoteMax()- Returns:
- maximum allowed cardinality for note. Note that with patterns, this may be different for the underlying resource
-
addNote
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addNote
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
#note
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
-