
Package org.hl7.fhir.r5.patterns
Interface Fivews
- All Superinterfaces:
PatternBase
Who What When Where Why - Common pattern for all resources that deals with attribution.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
static class
-
Method Summary
Modifier and TypeMethodDescriptionaddActor()
addCause()
addPlanned
(Timing t) addWhere()
addWho()
addWhy()
fhirType()
getActor()
int
int
int
int
getCause()
int
int
int
int
int
int
getDone()
int
int
getGrade()
int
int
int
int
getInit()
int
int
int
int
int
int
int
int
int
int
int
int
int
int
getWhat()
int
int
getWhere()
int
int
getWho()
int
int
getWhy()
int
int
int
int
boolean
hasActor()
boolean
boolean
hasCause()
boolean
boolean
boolean
hasDone()
boolean
boolean
boolean
hasGrade()
boolean
boolean
hasInit()
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
boolean
hasWhat()
boolean
boolean
boolean
hasWhere()
boolean
hasWho()
boolean
hasWhy()
boolean
setClass_
(List<CodeableConcept> theClass_) setContext
(Reference value) setGrade
(CodeableConcept value) setIdentifier
(List<Identifier> theIdentifier) setInitElement
(DateTimeType value) setPlanned
(List<Timing> thePlanned) setRecorded
(Date value) setRecordedElement
(InstantType value) setStatus
(Fivews.CanonicalStatus value) setSubject
(List<Reference> theSubject) setVersion
(String value) setVersionElement
(StringType value) setWitness
(List<Reference> theWitness) Methods inherited from interface org.hl7.fhir.r5.patterns.PatternBase
getExtension, getId, setId
-
Method Details
-
getIdentifier
- Returns:
#identifier
(Business Identifier.)- 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
-
getVersionElement
- Returns:
#version
(Identifier for this version.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasVersion
boolean hasVersion()- Returns:
- whether there is more than zero values for version
-
getVersionMin
- Returns:
- minimum allowed cardinality for version. Note that with patterns, this may be different for the underlying resource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getVersionMax
- Returns:
- maximum allowed cardinality for version. Note that with patterns, this may be different for the underlying resource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasVersionElement
boolean hasVersionElement() -
setVersionElement
- Parameters:
value
-#version
(Identifier for this version.). This is the underlying object with id, value and extensions. The accessor "getVersion" gives direct access to the value- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getVersion
- Returns:
- Identifier for this version.
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setVersion
- Parameters:
value
- Identifier for this version.- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getStatusElement
- Returns:
#status
(Status Field.). 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
Fivews setStatusElement(Enumeration<Fivews.CanonicalStatus> value) throws org.hl7.fhir.exceptions.FHIRException - Parameters:
value
-#status
(Status Field.). 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:
- Status Field.
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setStatus
- Parameters:
value
- Status Field.- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getClass_
- Returns:
#class_
(Classifier Field.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setClass_
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasClass_
boolean hasClass_()- Returns:
- whether there is more than zero values for class_
-
getClass_Min
int getClass_Min()- Returns:
- minimum allowed cardinality for class_. Note that with patterns, this may be different for the underlying resource
-
getClass_Max
int getClass_Max()- Returns:
- maximum allowed cardinality for class_. Note that with patterns, this may be different for the underlying resource
-
addClass_
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addClass_
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getClass_FirstRep
- Returns:
- The first repetition of repeating field
#class_
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getGrade
- Returns:
#grade
(A field that indicates the potential impact of the content of the resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasGrade
boolean hasGrade()- Returns:
- whether there is more than zero values for grade
-
getGradeMin
int getGradeMin()- Returns:
- minimum allowed cardinality for grade. Note that with patterns, this may be different for the underlying resource
-
getGradeMax
int getGradeMax()- Returns:
- maximum allowed cardinality for grade. Note that with patterns, this may be different for the underlying resource
-
setGrade
- Parameters:
value
-#grade
(A field that indicates the potential impact of the content of the resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWhat
- Returns:
#what
(what this resource is about.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWhatCodeableConcept
- Returns:
#what
(what this resource is about.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasWhatCodeableConcept
boolean hasWhatCodeableConcept() -
getWhatReference
- Returns:
#what
(what this resource is about.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasWhatReference
boolean hasWhatReference() -
hasWhat
boolean hasWhat()- Returns:
- whether there is more than zero values for what
-
getWhatMin
int getWhatMin()- Returns:
- minimum allowed cardinality for what. Note that with patterns, this may be different for the underlying resource
-
getWhatMax
int getWhatMax()- Returns:
- maximum allowed cardinality for what. Note that with patterns, this may be different for the underlying resource
-
setWhat
- Parameters:
value
-#what
(what this resource is about.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getSubject
- Returns:
#subject
(Who this resource is about.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setSubject
- Returns:
- Returns a reference to
this
for easy method chaining - 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
-
addSubject
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addSubject
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getSubjectFirstRep
- Returns:
- The first repetition of repeating field
#subject
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getContext
- Returns:
#context
(a resource that gives context for the work described in this resource (usually Encounter or EpisodeOfCare).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasContext
boolean hasContext()- Returns:
- whether there is more than zero values for context
-
getContextMin
int getContextMin()- Returns:
- minimum allowed cardinality for context. Note that with patterns, this may be different for the underlying resource
-
getContextMax
int getContextMax()- Returns:
- maximum allowed cardinality for context. Note that with patterns, this may be different for the underlying resource
-
setContext
- Parameters:
value
-#context
(a resource that gives context for the work described in this resource (usually Encounter or EpisodeOfCare).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getInitElement
- Returns:
#init
(when the work described in this resource was started (or will be).). This is the underlying object with id, value and extensions. The accessor "getInit" gives direct access to the value- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasInit
boolean hasInit()- Returns:
- whether there is more than zero values for init
-
getInitMin
- Returns:
- minimum allowed cardinality for init. Note that with patterns, this may be different for the underlying resource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getInitMax
- Returns:
- maximum allowed cardinality for init. Note that with patterns, this may be different for the underlying resource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasInitElement
boolean hasInitElement() -
setInitElement
- Parameters:
value
-#init
(when the work described in this resource was started (or will be).). This is the underlying object with id, value and extensions. The accessor "getInit" gives direct access to the value- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getInit
- Returns:
- when the work described in this resource was started (or will be).
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setInit
- Parameters:
value
- when the work described in this resource was started (or will be).- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getPlanned
- Returns:
#planned
(when this resource is planned to occur.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setPlanned
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasPlanned
boolean hasPlanned()- Returns:
- whether there is more than zero values for planned
-
getPlannedMin
int getPlannedMin()- Returns:
- minimum allowed cardinality for planned. Note that with patterns, this may be different for the underlying resource
-
getPlannedMax
int getPlannedMax()- Returns:
- maximum allowed cardinality for planned. Note that with patterns, this may be different for the underlying resource
-
addPlanned
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addPlanned
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getPlannedFirstRep
- Returns:
- The first repetition of repeating field
#planned
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getDone
- Returns:
#done
(when the work described in this resource was completed (or will be).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getDoneDateTimeType
- Returns:
#done
(when the work described in this resource was completed (or will be).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDoneDateTimeType
boolean hasDoneDateTimeType() -
getDonePeriod
- Returns:
#done
(when the work described in this resource was completed (or will be).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasDonePeriod
boolean hasDonePeriod() -
hasDone
boolean hasDone()- Returns:
- whether there is more than zero values for done
-
getDoneMin
int getDoneMin()- Returns:
- minimum allowed cardinality for done. Note that with patterns, this may be different for the underlying resource
-
getDoneMax
int getDoneMax()- Returns:
- maximum allowed cardinality for done. Note that with patterns, this may be different for the underlying resource
-
setDone
- Parameters:
value
-#done
(when the work described in this resource was completed (or will be).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getRecordedElement
- Returns:
#recorded
(when this resource itself was created.). 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
(when this resource itself was created.). 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:
- when this resource itself was created.
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setRecorded
- Parameters:
value
- when this resource itself was created.- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getAuthor
- Returns:
#author
(who authored the content of the resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setAuthor
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasAuthor
boolean hasAuthor()- Returns:
- whether there is more than zero values for author
-
getAuthorMin
int getAuthorMin()- Returns:
- minimum allowed cardinality for author. Note that with patterns, this may be different for the underlying resource
-
getAuthorMax
int getAuthorMax()- Returns:
- maximum allowed cardinality for author. Note that with patterns, this may be different for the underlying resource
-
addAuthor
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addAuthor
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getAuthorFirstRep
- Returns:
- The first repetition of repeating field
#author
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getSource
- Returns:
#source
(Who provided the information in this resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setSource
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasSource
boolean hasSource()- Returns:
- whether there is more than zero values for source
-
getSourceMin
int getSourceMin()- Returns:
- minimum allowed cardinality for source. Note that with patterns, this may be different for the underlying resource
-
getSourceMax
int getSourceMax()- Returns:
- maximum allowed cardinality for source. Note that with patterns, this may be different for the underlying resource
-
addSource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addSource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getSourceFirstRep
- Returns:
- The first repetition of repeating field
#source
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getActor
- Returns:
#actor
(who did the work described the resource (or will do).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setActor
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasActor
boolean hasActor()- Returns:
- whether there is more than zero values for actor
-
getActorMin
int getActorMin()- Returns:
- minimum allowed cardinality for actor. Note that with patterns, this may be different for the underlying resource
-
getActorMax
int getActorMax()- Returns:
- maximum allowed cardinality for actor. Note that with patterns, this may be different for the underlying resource
-
addActor
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addActor
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getActorFirstRep
- Returns:
- The first repetition of repeating field
#actor
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getCause
- Returns:
#cause
(who prompted the work described in the resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setCause
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasCause
boolean hasCause()- Returns:
- whether there is more than zero values for cause
-
getCauseMin
int getCauseMin()- Returns:
- minimum allowed cardinality for cause. Note that with patterns, this may be different for the underlying resource
-
getCauseMax
int getCauseMax()- Returns:
- maximum allowed cardinality for cause. Note that with patterns, this may be different for the underlying resource
-
addCause
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addCause
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getCauseFirstRep
- Returns:
- The first repetition of repeating field
#cause
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWitness
- Returns:
#witness
(who attests to the content of the resource (individual or org).)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setWitness
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasWitness
boolean hasWitness()- Returns:
- whether there is more than zero values for witness
-
getWitnessMin
int getWitnessMin()- Returns:
- minimum allowed cardinality for witness. Note that with patterns, this may be different for the underlying resource
-
getWitnessMax
int getWitnessMax()- Returns:
- maximum allowed cardinality for witness. Note that with patterns, this may be different for the underlying resource
-
addWitness
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addWitness
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWitnessFirstRep
- Returns:
- The first repetition of repeating field
#witness
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWho
- Returns:
#who
(An actor involved in the work described by this resource.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setWho
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasWho
boolean hasWho()- Returns:
- whether there is more than zero values for who
-
getWhoMin
int getWhoMin()- Returns:
- minimum allowed cardinality for who. Note that with patterns, this may be different for the underlying resource
-
getWhoMax
int getWhoMax()- Returns:
- maximum allowed cardinality for who. Note that with patterns, this may be different for the underlying resource
-
addWho
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addWho
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWhoFirstRep
- Returns:
- The first repetition of repeating field
#who
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWhere
- Returns:
#where
(The location of the work described.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setWhere
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasWhere
boolean hasWhere()- Returns:
- whether there is more than zero values for where
-
getWhereMin
int getWhereMin()- Returns:
- minimum allowed cardinality for where. Note that with patterns, this may be different for the underlying resource
-
getWhereMax
int getWhereMax()- Returns:
- maximum allowed cardinality for where. Note that with patterns, this may be different for the underlying resource
-
addWhere
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addWhere
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWhereFirstRep
- Returns:
- The first repetition of repeating field
#where
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWhy
- Returns:
#why
(Why this work was done.)- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setWhy
- Returns:
- Returns a reference to
this
for easy method chaining - Throws:
org.hl7.fhir.exceptions.FHIRException
-
hasWhy
boolean hasWhy()- Returns:
- whether there is more than zero values for why
-
getWhyMin
int getWhyMin()- Returns:
- minimum allowed cardinality for why. Note that with patterns, this may be different for the underlying resource
-
getWhyMax
int getWhyMax()- Returns:
- maximum allowed cardinality for why. Note that with patterns, this may be different for the underlying resource
-
addWhy
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addWhy
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getWhyFirstRep
- Returns:
- The first repetition of repeating field
#why
, creating it if it does not already exist - Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
-