Package org.hl7.fhir.dstu2.model
Class List_
-
- 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 List_ extends DomainResource
A set of information summarized from a list of other resources.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classList_.ListEntryComponentstatic classList_.ListModestatic classList_.ListModeEnumFactorystatic classList_.ListStatusstatic classList_.ListStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptcodeThis code defines the purpose of the list - why it was created.protected DateTimeTypedateThe date that the list was prepared.protected CodeableConceptemptyReasonIf the list is empty, why the list is empty.protected ReferenceencounterThe encounter that is the context in which this list was created.protected EncounterencounterTargetThe actual object that is the target of the reference (The encounter that is the context in which this list was created.)protected List<List_.ListEntryComponent>entryEntries in this list.protected List<Identifier>identifierIdentifier for the List assigned for business purposes outside the context of FHIR.protected Enumeration<List_.ListMode>modeHow 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 StringTypenoteComments that apply to the overall list.protected CodeableConceptorderedByWhat order applies to the items in the list.protected ReferencesourceThe entity responsible for deciding what the contents of the list were.protected ResourcesourceTargetThe actual object that is the target of the reference (The entity responsible for deciding what the contents of the list were.static StringSP_CODEstatic StringSP_DATEstatic StringSP_EMPTYREASONstatic StringSP_ENCOUNTERstatic StringSP_ITEMstatic StringSP_NOTESstatic StringSP_PATIENTstatic StringSP_SOURCEstatic StringSP_STATUSstatic StringSP_SUBJECTstatic StringSP_TITLEprotected Enumeration<List_.ListStatus>statusIndicates the current state of this list.protected ReferencesubjectThe common subject (or patient) of the resources that are in the list, if there is one.protected ResourcesubjectTargetThe 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 StringTypetitleA label for the list assigned by the author.-
Fields inherited from class org.hl7.fhir.dstu2.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu2.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description List_()List_(Enumeration<List_.ListStatus> status, Enumeration<List_.ListMode> mode)
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu2.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getModifierExtension, getText, hasContained, hasExtension, hasModifierExtension, hasText, setText
-
Methods inherited from class org.hl7.fhir.dstu2.model.Resource
copyValues, getId, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.dstu2.model.BaseResource
getStructureFhirVersionEnum, setId
-
Methods inherited from class org.hl7.fhir.dstu2.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactPoint, castToDate, castToDateTime, castToDecimal, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToUnsignedInt, castToUri, children, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getUserData, getUserInt, getUserString, hasFormatComment, hasType, hasUserData, isMetadataBased, isPrimitive, 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
Identifier for the List assigned for business purposes outside the context of FHIR.
-
title
protected StringType title
A label for the list assigned by the author.
-
code
protected CodeableConcept code
This code defines the purpose of the list - why it was created.
-
subject
protected Reference subject
The common subject (or patient) of the resources that are in the list, if there is one.
-
subjectTarget
protected Resource 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.)
-
source
protected Reference 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
protected Resource 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.)
-
encounter
protected Reference encounter
The encounter that is the context in which this list was created.
-
encounterTarget
protected Encounter encounterTarget
The actual object that is the target of the reference (The encounter that is the context in which this list was created.)
-
status
protected Enumeration<List_.ListStatus> status
Indicates the current state of this list.
-
date
protected DateTimeType date
The date that the list was prepared.
-
orderedBy
protected CodeableConcept orderedBy
What order applies to the items in the list.
-
mode
protected Enumeration<List_.ListMode> 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.
-
note
protected StringType note
Comments that apply to the overall list.
-
entry
protected List<List_.ListEntryComponent> entry
Entries in this list.
-
emptyReason
protected CodeableConcept emptyReason
If the list is empty, why the list is empty.
-
SP_DATE
public static final String SP_DATE
- See Also:
- Constant Field Values
-
SP_ITEM
public static final String SP_ITEM
- See Also:
- Constant Field Values
-
SP_EMPTYREASON
public static final String SP_EMPTYREASON
- See Also:
- Constant Field Values
-
SP_CODE
public static final String SP_CODE
- See Also:
- Constant Field Values
-
SP_NOTES
public static final String SP_NOTES
- See Also:
- Constant Field Values
-
SP_SUBJECT
public static final String SP_SUBJECT
- See Also:
- Constant Field Values
-
SP_PATIENT
public static final String SP_PATIENT
- See Also:
- Constant Field Values
-
SP_SOURCE
public static final String SP_SOURCE
- See Also:
- Constant Field Values
-
SP_ENCOUNTER
public static final String SP_ENCOUNTER
- See Also:
- Constant Field Values
-
SP_TITLE
public static final String SP_TITLE
- See Also:
- Constant Field Values
-
SP_STATUS
public static final String SP_STATUS
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
List_
public List_()
-
List_
public List_(Enumeration<List_.ListStatus> status, Enumeration<List_.ListMode> mode)
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifier for the List assigned for business purposes outside the context of FHIR.)
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
- Returns:
identifier(Identifier for the List assigned for business purposes outside the context of FHIR.)
-
addIdentifier
public List_ addIdentifier(Identifier t)
-
getTitleElement
public StringType 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
public boolean hasTitleElement()
-
hasTitle
public boolean hasTitle()
-
setTitleElement
public List_ setTitleElement(StringType value)
- 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
-
setTitle
public List_ setTitle(String value)
- Parameters:
value- A label for the list assigned by the author.
-
getCode
public CodeableConcept getCode()
- Returns:
code(This code defines the purpose of the list - why it was created.)
-
hasCode
public boolean hasCode()
-
setCode
public List_ setCode(CodeableConcept value)
- Parameters:
value-code(This code defines the purpose of the list - why it was created.)
-
getSubject
public Reference getSubject()
- Returns:
subject(The common subject (or patient) of the resources that are in the list, if there is one.)
-
hasSubject
public boolean hasSubject()
-
setSubject
public List_ setSubject(Reference value)
- Parameters:
value-subject(The common subject (or patient) of the resources that are in the list, if there is one.)
-
getSubjectTarget
public Resource getSubjectTarget()
- Returns:
subjectThe 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
public List_ setSubjectTarget(Resource value)
- Parameters:
value-subjectThe 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.)
-
getSource
public Reference 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
public boolean hasSource()
-
setSource
public List_ setSource(Reference value)
- 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
public Resource getSourceTarget()
- Returns:
sourceThe 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
public List_ setSourceTarget(Resource value)
- Parameters:
value-sourceThe 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.)
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(The encounter that is the context in which this list was created.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public List_ setEncounter(Reference value)
- Parameters:
value-encounter(The encounter that is the context in which this list was created.)
-
getEncounterTarget
public Encounter getEncounterTarget()
- Returns:
encounterThe 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
public List_ setEncounterTarget(Encounter value)
- Parameters:
value-encounterThe 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.)
-
getStatusElement
public Enumeration<List_.ListStatus> 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
public boolean hasStatusElement()
-
hasStatus
public boolean hasStatus()
-
setStatusElement
public List_ setStatusElement(Enumeration<List_.ListStatus> value)
- 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
public List_.ListStatus getStatus()
- Returns:
- Indicates the current state of this list.
-
setStatus
public List_ setStatus(List_.ListStatus value)
- Parameters:
value- Indicates the current state of this list.
-
getDateElement
public DateTimeType 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
public boolean hasDateElement()
-
hasDate
public boolean hasDate()
-
setDateElement
public List_ setDateElement(DateTimeType value)
- 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
-
getOrderedBy
public CodeableConcept getOrderedBy()
- Returns:
orderedBy(What order applies to the items in the list.)
-
hasOrderedBy
public boolean hasOrderedBy()
-
setOrderedBy
public List_ setOrderedBy(CodeableConcept value)
- Parameters:
value-orderedBy(What order applies to the items in the list.)
-
getModeElement
public Enumeration<List_.ListMode> 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
public boolean hasModeElement()
-
hasMode
public boolean hasMode()
-
setModeElement
public List_ setModeElement(Enumeration<List_.ListMode> value)
- 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
public List_.ListMode 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
public List_ setMode(List_.ListMode value)
- 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.
-
getNoteElement
public StringType getNoteElement()
- Returns:
note(Comments that apply to the overall list.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
-
hasNoteElement
public boolean hasNoteElement()
-
hasNote
public boolean hasNote()
-
setNoteElement
public List_ setNoteElement(StringType value)
- Parameters:
value-note(Comments that apply to the overall list.). This is the underlying object with id, value and extensions. The accessor "getNote" gives direct access to the value
-
setNote
public List_ setNote(String value)
- Parameters:
value- Comments that apply to the overall list.
-
getEntry
public List<List_.ListEntryComponent> getEntry()
- Returns:
entry(Entries in this list.)
-
hasEntry
public boolean hasEntry()
-
addEntry
public List_.ListEntryComponent addEntry()
- Returns:
entry(Entries in this list.)
-
addEntry
public List_ addEntry(List_.ListEntryComponent t)
-
getEmptyReason
public CodeableConcept getEmptyReason()
- Returns:
emptyReason(If the list is empty, why the list is empty.)
-
hasEmptyReason
public boolean hasEmptyReason()
-
setEmptyReason
public List_ setEmptyReason(CodeableConcept value)
- Parameters:
value-emptyReason(If the list is empty, why the list is empty.)
-
listChildren
protected void listChildren(List<Property> childrenList)
- Overrides:
listChildrenin classDomainResource
-
setProperty
public void setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setPropertyin 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 List_ copy()
- Specified by:
copyin classDomainResource
-
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
-
-