Class ListResource
- All Implemented Interfaces:
ca.uhn.fhir.model.api.IElement
,Serializable
,org.hl7.fhir.instance.model.api.IAnyResource
,org.hl7.fhir.instance.model.api.IBase
,org.hl7.fhir.instance.model.api.IBaseHasExtensions
,org.hl7.fhir.instance.model.api.IBaseHasModifierExtensions
,org.hl7.fhir.instance.model.api.IBaseResource
,org.hl7.fhir.instance.model.api.IDomainResource
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
static enum
static class
static enum
static class
-
Field Summary
Modifier and TypeFieldDescriptionprotected CodeableConcept
This code defines the purpose of the list - why it was created.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for codeprotected DateTimeType
The date that the list was prepared.static final ca.uhn.fhir.rest.gclient.DateClientParam
Fluent Client search parameter constant for datestatic final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for empty-reasonprotected CodeableConcept
If the list is empty, why the list is empty.protected Reference
The encounter that is the context in which this list was created.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for encounterprotected Encounter
The actual object that is the target of the reference (The encounter that is the context in which this list was created.)protected List
<ListResource.ListEntryComponent> Entries in this list.protected List
<Identifier> Identifier for the List assigned for business purposes outside the context of FHIR.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.Include
Constant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for itemprotected Enumeration
<ListResource.ListMode> How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.protected List
<Annotation> Comments that apply to the overall list.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for notesprotected CodeableConcept
What order applies to the items in the list.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for patientprotected Reference
The entity responsible for deciding what the contents of the list were.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for sourceprotected Resource
The actual object that is the target of the reference (The entity responsible for deciding what the contents of the list were.static final String
Search parameter: codestatic final String
Search parameter: datestatic final String
Search parameter: empty-reasonstatic final String
Search parameter: encounterstatic final String
Search parameter: identifierstatic final String
Search parameter: itemstatic final String
Search parameter: notesstatic final String
Search parameter: patientstatic final String
Search parameter: sourcestatic final String
Search parameter: statusstatic final String
Search parameter: subjectstatic final String
Search parameter: titleprotected Enumeration
<ListResource.ListStatus> Indicates the current state of this list.static final ca.uhn.fhir.rest.gclient.TokenClientParam
Fluent Client search parameter constant for statusprotected Reference
The common subject (or patient) of the resources that are in the list if there is one.static final ca.uhn.fhir.rest.gclient.ReferenceClientParam
Fluent Client search parameter constant for subjectprotected Resource
The actual object that is the target of the reference (The common subject (or patient) of the resources that are in the list if there is one.)protected StringType
A label for the list assigned by the author.static final ca.uhn.fhir.rest.gclient.StringClientParam
Fluent Client search parameter constant for titleFields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
Fields inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
RES_ID, RES_LAST_UPDATED, RES_PROFILE, RES_SECURITY, RES_TAG, SP_RES_ID, SP_RES_LAST_UPDATED, SP_RES_PROFILE, SP_RES_SECURITY, SP_RES_TAG
Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET
-
Constructor Summary
ConstructorDescriptionConstructorListResource
(Enumeration<ListResource.ListStatus> status, Enumeration<ListResource.ListMode> mode) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddEntry()
addNote()
copy()
void
copyValues
(ListResource dst) boolean
equalsDeep
(Base other_) boolean
equalsShallow
(Base other_) fhirType()
getCode()
getDate()
getEntry()
getMode()
getNamedProperty
(int _hash, String _name, boolean _checkValid) getNote()
Base[]
getProperty
(int hash, String name, boolean checkValid) getTitle()
String[]
getTypesForProperty
(int hash, String name) boolean
hasCode()
boolean
hasDate()
boolean
boolean
boolean
boolean
hasEntry()
boolean
boolean
hasMode()
boolean
boolean
hasNote()
boolean
boolean
boolean
boolean
boolean
boolean
hasTitle()
boolean
boolean
isEmpty()
protected void
listChildren
(List<Property> children) makeProperty
(int hash, String name) void
removeChild
(String name, Base value) setCode
(CodeableConcept value) setDateElement
(DateTimeType value) setEmptyReason
(CodeableConcept value) setEncounter
(Reference value) setEncounterTarget
(Encounter value) setEntry
(List<ListResource.ListEntryComponent> theEntry) setIdentifier
(List<Identifier> theIdentifier) setMode
(ListResource.ListMode value) setNote
(List<Annotation> theNote) setOrderedBy
(CodeableConcept value) setProperty
(int hash, String name, Base value) setProperty
(String name, Base value) setSourceTarget
(Resource value) setStatus
(ListResource.ListStatus value) setSubject
(Reference value) setSubjectTarget
(Resource value) setTitleElement
(StringType value) protected ListResource
Methods inherited from class org.hl7.fhir.r4.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.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getIdPart, 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.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, 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
Methods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatComment
Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Identifier for the List assigned for business purposes outside the context of FHIR. -
status
Indicates the current state of this list. -
mode
How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted. -
title
A label for the list assigned by the author. -
code
This code defines the purpose of the list - why it was created. -
subject
The common subject (or patient) of the resources that are in the list if there is one. -
subjectTarget
The actual object that is the target of the reference (The common subject (or patient) of the resources that are in the list if there is one.) -
encounter
The encounter that is the context in which this list was created. -
encounterTarget
The actual object that is the target of the reference (The encounter that is the context in which this list was created.) -
date
The date that the list was prepared. -
source
The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list. -
sourceTarget
The actual object that is the target of the reference (The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.) -
orderedBy
What order applies to the items in the list. -
note
Comments that apply to the overall list. -
entry
Entries in this list. -
emptyReason
If the list is empty, why the list is empty. -
SP_DATE
Search parameter: dateDescription: When the list was prepared
Type: date
Path: List.date
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: When the list was prepared
Type: date
Path: List.date
-
SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier
Type: token
Path: List.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier
Type: token
Path: List.identifier
-
SP_ITEM
Search parameter: itemDescription: Actual entry
Type: reference
Path: List.entry.item
- See Also:
-
ITEM
Fluent Client search parameter constant for itemDescription: Actual entry
Type: reference
Path: List.entry.item
-
INCLUDE_ITEM
Constant for fluent queries to be used to add include statements. Specifies the path value of "List:item". -
SP_EMPTY_REASON
Search parameter: empty-reasonDescription: Why list is empty
Type: token
Path: List.emptyReason
- See Also:
-
EMPTY_REASON
Fluent Client search parameter constant for empty-reasonDescription: Why list is empty
Type: token
Path: List.emptyReason
-
SP_CODE
Search parameter: codeDescription: What the purpose of this list is
Type: token
Path: List.code
- See Also:
-
CODE
Fluent Client search parameter constant for codeDescription: What the purpose of this list is
Type: token
Path: List.code
-
SP_NOTES
Search parameter: notesDescription: The annotation - text content (as markdown)
Type: string
Path: List.note.text
- See Also:
-
NOTES
Fluent Client search parameter constant for notesDescription: The annotation - text content (as markdown)
Type: string
Path: List.note.text
-
SP_SUBJECT
Search parameter: subjectDescription: If all resources have the same subject
Type: reference
Path: List.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: If all resources have the same subject
Type: reference
Path: List.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "List:subject". -
SP_PATIENT
Search parameter: patientDescription: If all resources have the same subject
Type: reference
Path: List.subject
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: If all resources have the same subject
Type: reference
Path: List.subject
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "List:patient". -
SP_SOURCE
Search parameter: sourceDescription: Who and/or what defined the list contents (aka Author)
Type: reference
Path: List.source
- See Also:
-
SOURCE
Fluent Client search parameter constant for sourceDescription: Who and/or what defined the list contents (aka Author)
Type: reference
Path: List.source
-
INCLUDE_SOURCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "List:source". -
SP_ENCOUNTER
Search parameter: encounterDescription: Context in which list created
Type: reference
Path: List.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Context in which list created
Type: reference
Path: List.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "List:encounter". -
SP_TITLE
Search parameter: titleDescription: Descriptive name for the list
Type: string
Path: List.title
- See Also:
-
TITLE
Fluent Client search parameter constant for titleDescription: Descriptive name for the list
Type: string
Path: List.title
-
SP_STATUS
Search parameter: statusDescription: current | retired | entered-in-error
Type: token
Path: List.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: current | retired | entered-in-error
Type: token
Path: List.status
-
-
Constructor Details
-
ListResource
public ListResource()Constructor -
ListResource
public ListResource(Enumeration<ListResource.ListStatus> status, Enumeration<ListResource.ListMode> mode) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier
(Identifier for the List assigned for business purposes outside the context of FHIR.)
-
setIdentifier
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier
, creating it if it does not already exist
-
getStatusElement
- Returns:
status
(Indicates the current state of this list.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
hasStatusElement
-
hasStatus
-
setStatusElement
- Parameters:
value
-status
(Indicates the current state of this list.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- Indicates the current state of this list.
-
setStatus
- Parameters:
value
- Indicates the current state of this list.
-
getModeElement
- Returns:
mode
(How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
-
hasModeElement
-
hasMode
-
setModeElement
- Parameters:
value
-mode
(How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.). This is the underlying object with id, value and extensions. The accessor "getMode" gives direct access to the value
-
getMode
- Returns:
- How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
setMode
- Parameters:
value
- How this list was prepared - whether it is a working list that is suitable for being maintained on an ongoing basis, or if it represents a snapshot of a list of items from another source, or whether it is a prepared list where items may be marked as added, modified or deleted.
-
getTitleElement
- Returns:
title
(A label for the list assigned by the author.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
hasTitleElement
-
hasTitle
-
setTitleElement
- Parameters:
value
-title
(A label for the list assigned by the author.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Returns:
- A label for the list assigned by the author.
-
setTitle
- Parameters:
value
- A label for the list assigned by the author.
-
getCode
- Returns:
code
(This code defines the purpose of the list - why it was created.)
-
hasCode
-
setCode
- Parameters:
value
-code
(This code defines the purpose of the list - why it was created.)
-
getSubject
- Returns:
subject
(The common subject (or patient) of the resources that are in the list if there is one.)
-
hasSubject
-
setSubject
- Parameters:
value
-subject
(The common subject (or patient) of the resources that are in the list if there is one.)
-
getSubjectTarget
- Returns:
subject
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The common subject (or patient) of the resources that are in the list if there is one.)
-
setSubjectTarget
- Parameters:
value
-subject
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The common subject (or patient) of the resources that are in the list if there is one.)
-
getEncounter
- Returns:
encounter
(The encounter that is the context in which this list was created.)
-
hasEncounter
-
setEncounter
- Parameters:
value
-encounter
(The encounter that is the context in which this list was created.)
-
getEncounterTarget
- Returns:
encounter
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The encounter that is the context in which this list was created.)
-
setEncounterTarget
- Parameters:
value
-encounter
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The encounter that is the context in which this list was created.)
-
getDateElement
- Returns:
date
(The date that the list was prepared.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
hasDateElement
-
hasDate
-
setDateElement
- Parameters:
value
-date
(The date that the list was prepared.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
getDate
- Returns:
- The date that the list was prepared.
-
setDate
- Parameters:
value
- The date that the list was prepared.
-
getSource
- Returns:
source
(The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.)
-
hasSource
-
setSource
- Parameters:
value
-source
(The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.)
-
getSourceTarget
- Returns:
source
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.)
-
setSourceTarget
- Parameters:
value
-source
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The entity responsible for deciding what the contents of the list were. Where the list was created by a human, this is the same as the author of the list.)
-
getOrderedBy
- Returns:
orderedBy
(What order applies to the items in the list.)
-
hasOrderedBy
-
setOrderedBy
- Parameters:
value
-orderedBy
(What order applies to the items in the list.)
-
getNote
- Returns:
note
(Comments that apply to the overall list.)
-
setNote
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note
, creating it if it does not already exist
-
getEntry
- Returns:
entry
(Entries in this list.)
-
setEntry
- Returns:
- Returns a reference to
this
for easy method chaining
-
hasEntry
-
addEntry
-
addEntry
-
getEntryFirstRep
- Returns:
- The first repetition of repeating field
entry
, creating it if it does not already exist
-
getEmptyReason
- Returns:
emptyReason
(If the list is empty, why the list is empty.)
-
hasEmptyReason
-
setEmptyReason
- Parameters:
value
-emptyReason
(If the list is empty, why the list is empty.)
-
listChildren
- Overrides:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException - Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
- Specified by:
copy
in classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
- Specified by:
getResourceType
in classResource
-