Class ListResource
- java.lang.Object
-
- org.hl7.fhir.r4b.model.Base
-
- org.hl7.fhir.r4b.model.BaseResource
-
- org.hl7.fhir.r4b.model.Resource
-
- org.hl7.fhir.r4b.model.DomainResource
-
- org.hl7.fhir.r4b.model.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
public class ListResource extends DomainResource
A list is a curated collection of resources.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListResource.ListResourceEntryComponentstatic classListResource.ListStatusstatic classListResource.ListStatusEnumFactory
-
Field Summary
Fields Modifier and Type Field Description protected CodeableConceptcodeThis code defines the purpose of the list - why it was created.static ca.uhn.fhir.rest.gclient.TokenClientParamCODEFluent Client search parameter constant for codeprotected DateTimeTypedateThe date that the list was prepared.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.TokenClientParamEMPTY_REASONFluent Client search parameter constant for empty-reasonprotected CodeableConceptemptyReasonIf the list is empty, why the list is empty.protected ReferenceencounterThe encounter that is the context in which this list was created.static ca.uhn.fhir.rest.gclient.ReferenceClientParamENCOUNTERFluent Client search parameter constant for encounterprotected List<ListResource.ListResourceEntryComponent>entryEntries in this list.protected List<Identifier>identifierIdentifier for the List assigned for business purposes outside the context of FHIR.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_ENCOUNTERConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.IncludeINCLUDE_ITEMConstant 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_SOURCEConstant 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.ReferenceClientParamITEMFluent Client search parameter constant for itemprotected Enumeration<Enumerations.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 List<Annotation>noteComments that apply to the overall list.static ca.uhn.fhir.rest.gclient.StringClientParamNOTESFluent Client search parameter constant for notesprotected CodeableConceptorderedByWhat order applies to the items in the list.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected ReferencesourceThe entity responsible for deciding what the contents of the list were.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSOURCEFluent Client search parameter constant for sourcestatic StringSP_CODESearch parameter: codestatic StringSP_DATESearch parameter: datestatic StringSP_EMPTY_REASONSearch parameter: empty-reasonstatic StringSP_ENCOUNTERSearch parameter: encounterstatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_ITEMSearch parameter: itemstatic StringSP_NOTESSearch parameter: notesstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_SOURCESearch parameter: sourcestatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUBJECTSearch parameter: subjectstatic StringSP_TITLESearch parameter: titleprotected Enumeration<ListResource.ListStatus>statusIndicates the current state of this list.static ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusprotected ReferencesubjectThe common subject (or patient) of the resources that are in the list if there is one.static ca.uhn.fhir.rest.gclient.ReferenceClientParamSUBJECTFluent Client search parameter constant for subjectprotected StringTypetitleA label for the list assigned by the author.static ca.uhn.fhir.rest.gclient.StringClientParamTITLEFluent Client search parameter constant for title-
Fields inherited from class org.hl7.fhir.r4b.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXT
-
Fields inherited from class org.hl7.fhir.r4b.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ListResource()ConstructorListResource(ListResource.ListStatus status, Enumerations.ListMode mode)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4b.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.r4b.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.r4b.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4b.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
Identifier for the List assigned for business purposes outside the context of FHIR.
-
status
protected Enumeration<ListResource.ListStatus> status
Indicates the current state of this list.
-
mode
protected Enumeration<Enumerations.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.
-
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.
-
encounter
protected Reference encounter
The encounter that is the context in which this list was created.
-
date
protected DateTimeType date
The date that the list was prepared.
-
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.
-
orderedBy
protected CodeableConcept orderedBy
What order applies to the items in the list.
-
note
protected List<Annotation> note
Comments that apply to the overall list.
-
entry
protected List<ListResource.ListResourceEntryComponent> entry
Entries in this list.
-
emptyReason
protected CodeableConcept emptyReason
If the list is empty, why the list is empty.
-
SP_EMPTY_REASON
public static final String SP_EMPTY_REASON
Search parameter: empty-reasonDescription: Why list is empty
Type: token
Path: List.emptyReason
- See Also:
- Constant Field Values
-
EMPTY_REASON
public static final ca.uhn.fhir.rest.gclient.TokenClientParam EMPTY_REASON
Fluent Client search parameter constant for empty-reasonDescription: Why list is empty
Type: token
Path: List.emptyReason
-
SP_ITEM
public static final String SP_ITEM
Search parameter: itemDescription: Actual entry
Type: reference
Path: List.entry.item
- See Also:
- Constant Field Values
-
ITEM
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ITEM
Fluent Client search parameter constant for itemDescription: Actual entry
Type: reference
Path: List.entry.item
-
INCLUDE_ITEM
public static final ca.uhn.fhir.model.api.Include INCLUDE_ITEM
Constant for fluent queries to be used to add include statements. Specifies the path value of "List:item".
-
SP_NOTES
public static final String SP_NOTES
Search parameter: notesDescription: The annotation - text content (as markdown)
Type: string
Path: List.note.text
- See Also:
- Constant Field Values
-
NOTES
public static final ca.uhn.fhir.rest.gclient.StringClientParam NOTES
Fluent Client search parameter constant for notesDescription: The annotation - text content (as markdown)
Type: string
Path: List.note.text
-
SP_SOURCE
public static final String SP_SOURCE
Search parameter: sourceDescription: Who and/or what defined the list contents (aka Author)
Type: reference
Path: List.source
- See Also:
- Constant Field Values
-
SOURCE
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam 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
public static final ca.uhn.fhir.model.api.Include INCLUDE_SOURCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "List:source".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: current | retired | entered-in-error
Type: token
Path: List.status
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: current | retired | entered-in-error
Type: token
Path: List.status
-
SP_SUBJECT
public static final String SP_SUBJECT
Search parameter: subjectDescription: If all resources have the same subject
Type: reference
Path: List.subject
- See Also:
- Constant Field Values
-
SUBJECT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUBJECT
Fluent Client search parameter constant for subjectDescription: If all resources have the same subject
Type: reference
Path: List.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 "List:subject".
-
SP_TITLE
public static final String SP_TITLE
Search parameter: titleDescription: Descriptive name for the list
Type: string
Path: List.title
- See Also:
- Constant Field Values
-
TITLE
public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
Fluent Client search parameter constant for titleDescription: Descriptive name for the list
Type: string
Path: List.title
-
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 [MedicationStatement](medicationstatement.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 as CodeableConcept) | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | (MedicationAdministration.medication as CodeableConcept) | (MedicationDispense.medication as CodeableConcept) | (MedicationRequest.medication as CodeableConcept) | (MedicationStatement.medication as CodeableConcept) | 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 [MedicationStatement](medicationstatement.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 as CodeableConcept) | DiagnosticReport.code | FamilyMemberHistory.condition.code | List.code | Medication.code | (MedicationAdministration.medication as CodeableConcept) | (MedicationDispense.medication as CodeableConcept) | (MedicationRequest.medication as CodeableConcept) | (MedicationStatement.medication as CodeableConcept) | 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): Time period team covers [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When this Consent was created or indexed [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the period 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 was performed [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AllergyIntolerance.recordedDate | CarePlan.period | CareTeam.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.period | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | Immunization.occurrence | List.date | Observation.effective | Procedure.performed | (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): Time period team covers [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When this Consent was created or indexed [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [Encounter](encounter.html): A date within the period 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 was performed [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AllergyIntolerance.recordedDate | CarePlan.period | CareTeam.period | ClinicalImpression.date | Composition.date | Consent.dateTime | DiagnosticReport.effective | Encounter.period | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | Immunization.occurrence | List.date | Observation.effective | Procedure.performed | (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): Encounter created as part of [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.context.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): Encounter created as part of [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.context.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 "List: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): Master Version Specific Identifier [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 and Accession number [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 [MedicationStatement](medicationstatement.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.masterIdentifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.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): Master Version Specific Identifier [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 and Accession number [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 [MedicationStatement](medicationstatement.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.masterIdentifier | DocumentReference.identifier | Encounter.identifier | EpisodeOfCare.identifier | FamilyMemberHistory.identifier | Goal.identifier | ImagingStudy.identifier | Immunization.identifier | List.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.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 or group 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 [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient [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 or group 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 [MedicationStatement](medicationstatement.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.patient | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUseStatement.subject.where(resolve() is 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) | MedicationStatement.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 or group 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 [DeviceUseStatement](deviceusestatement.html): Search by subject - a patient [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 or group 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 [MedicationStatement](medicationstatement.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.patient | DetectedIssue.patient | DeviceRequest.subject.where(resolve() is Patient) | DeviceUseStatement.subject.where(resolve() is 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) | MedicationStatement.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 "List:patient".
-
-
Constructor Detail
-
ListResource
public ListResource()
Constructor
-
ListResource
public ListResource(ListResource.ListStatus status, Enumerations.ListMode mode)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(Identifier for the List assigned for business purposes outside the context of FHIR.)
-
setIdentifier
public ListResource setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ListResource addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getStatusElement
public Enumeration<ListResource.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 ListResource setStatusElement(Enumeration<ListResource.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 ListResource.ListStatus getStatus()
- Returns:
- Indicates the current state of this list.
-
setStatus
public ListResource setStatus(ListResource.ListStatus value)
- Parameters:
value- Indicates the current state of this list.
-
getModeElement
public Enumeration<Enumerations.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 ListResource setModeElement(Enumeration<Enumerations.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 Enumerations.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 ListResource setMode(Enumerations.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.
-
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 ListResource 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 ListResource 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 ListResource 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 ListResource setSubject(Reference value)
- Parameters:
value-subject(The common subject (or patient) of the resources that are in the list if there is one.)
-
getEncounter
public Reference getEncounter()
- Returns:
encounter(The encounter that is the context in which this list was created.)
-
hasEncounter
public boolean hasEncounter()
-
setEncounter
public ListResource setEncounter(Reference value)
- Parameters:
value-encounter(The encounter that is the context in which this list was created.)
-
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 ListResource 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
-
setDate
public ListResource setDate(Date value)
- Parameters:
value- The date that the list was prepared.
-
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 ListResource 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.)
-
getOrderedBy
public CodeableConcept getOrderedBy()
- Returns:
orderedBy(What order applies to the items in the list.)
-
hasOrderedBy
public boolean hasOrderedBy()
-
setOrderedBy
public ListResource setOrderedBy(CodeableConcept value)
- Parameters:
value-orderedBy(What order applies to the items in the list.)
-
getNote
public List<Annotation> getNote()
- Returns:
note(Comments that apply to the overall list.)
-
setNote
public ListResource setNote(List<Annotation> theNote)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
public boolean hasNote()
-
addNote
public Annotation addNote()
-
addNote
public ListResource addNote(Annotation t)
-
getNoteFirstRep
public Annotation getNoteFirstRep()
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist {3}
-
getEntry
public List<ListResource.ListResourceEntryComponent> getEntry()
- Returns:
entry(Entries in this list.)
-
setEntry
public ListResource setEntry(List<ListResource.ListResourceEntryComponent> theEntry)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasEntry
public boolean hasEntry()
-
addEntry
public ListResource.ListResourceEntryComponent addEntry()
-
addEntry
public ListResource addEntry(ListResource.ListResourceEntryComponent t)
-
getEntryFirstRep
public ListResource.ListResourceEntryComponent getEntryFirstRep()
- Returns:
- The first repetition of repeating field
entry, creating it if it does not already exist {3}
-
getEmptyReason
public CodeableConcept getEmptyReason()
- Returns:
emptyReason(If the list is empty, why the list is empty.)
-
hasEmptyReason
public boolean hasEmptyReason()
-
setEmptyReason
public ListResource setEmptyReason(CodeableConcept value)
- Parameters:
value-emptyReason(If the list is empty, why the list is empty.)
-
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 ListResource copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ListResource dst)
-
typedCopy
protected ListResource typedCopy()
-
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
-
-