
Class CarePlan
- 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
Nested ClassesModifier and TypeClassDescriptionstatic classstatic enumstatic classNested classes/interfaces inherited from class org.hl7.fhir.r5.model.Base
Base.ProfileSource, Base.ValidationInfo, Base.ValidationMode, Base.ValidationReason -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected List<CarePlan.CarePlanActivityComponent> Identifies an action that has occurred or is a planned action to occur as part of the plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for activity-referenceprotected List<CodeableReference> Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for based-onA higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for care-teamIdentifies all people and organizations who are expected to be involved in the care envisioned by this plan.protected List<CodeableConcept> Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for categorystatic final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for conditionIdentifies the individual(s), organization or device who provided the contents of the care plan.protected DateTimeTypeRepresents when this particular CarePlan record was created in the system, which is often a system-generated date.protected ReferenceWhen populated, the custodian is responsible for the care plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for custodianstatic final ca.uhn.fhir.rest.gclient.DateClientParamFluent Client search parameter constant for dateprotected StringTypeA description of the scope and nature of the plan.protected ReferenceThe Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for encounterDescribes the intended objective(s) of carrying out the care plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for goalprotected List<Identifier> Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for identifierstatic final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.model.api.IncludeConstant for fluent queries to be used to add include statements.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for instantiates-canonicalstatic final ca.uhn.fhir.rest.gclient.UriClientParamFluent Client search parameter constant for instantiates-uriprotected List<CanonicalType> The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.protected Enumeration<CarePlan.CarePlanIntent> Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for intentprotected List<Annotation> General notes about the care plan not covered elsewhere.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for part-ofA larger care plan of which this particular care plan is a component or step.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for patientprotected PeriodIndicates when the plan did (or is intended to) come into effect and end.Completed or terminated care plan whose function is taken by this new care plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for replacesstatic final StringSearch parameter: activity-referencestatic final StringSearch parameter: based-onstatic final StringSearch parameter: care-teamstatic final StringSearch parameter: categorystatic final StringSearch parameter: conditionstatic final StringSearch parameter: custodianstatic final StringSearch parameter: datestatic final StringSearch parameter: encounterstatic final StringSearch parameter: goalstatic final StringSearch parameter: identifierstatic final StringSearch parameter: instantiates-canonicalstatic final StringSearch parameter: instantiates-uristatic final StringSearch parameter: intentstatic final StringSearch parameter: part-ofstatic final StringSearch parameter: patientstatic final StringSearch parameter: replacesstatic final StringSearch parameter: statusstatic final StringSearch parameter: subjectprotected Enumeration<Enumerations.RequestStatus> Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.static final ca.uhn.fhir.rest.gclient.TokenClientParamFluent Client search parameter constant for statusprotected ReferenceIdentifies the patient or group whose intended care is described by the plan.static final ca.uhn.fhir.rest.gclient.ReferenceClientParamFluent Client search parameter constant for subjectIdentifies portions of the patient's record that specifically influenced the formation of the plan.protected StringTypeHuman-friendly name for the care plan.Fields inherited from class org.hl7.fhir.r5.model.DomainResource
contained, extension, modifierExtension, SP_TEXT, text, TEXTFields inherited from class org.hl7.fhir.r5.model.Resource
id, implicitRules, language, metaFields 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_TAGFields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
INCLUDE_ALL, WILDCARD_ALL_SET -
Constructor Summary
ConstructorsConstructorDescriptionCarePlan()ConstructorCarePlan(Enumerations.RequestStatus status, CarePlan.CarePlanIntent intent, Reference subject) Constructor -
Method Summary
Modifier and TypeMethodDescriptionaddGoal()addInstantiatesCanonical(String value) addInstantiatesUri(String value) addNote()copy()voidcopyValues(CarePlan dst) booleanequalsDeep(Base other_) booleanequalsShallow(Base other_) fhirType()getGoal()getNamedProperty(int _hash, String _name, boolean _checkValid) getNote()Base[]getProperty(int hash, String name, boolean checkValid) getTitle()String[]getTypesForProperty(int hash, String name) booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasGoal()booleanbooleanbooleanhasInstantiatesCanonical(String value) booleanbooleanhasInstantiatesUri(String value) booleanbooleanbooleanhasNote()booleanbooleanbooleanbooleanbooleanbooleanbooleanbooleanhasTitle()booleanbooleanisEmpty()protected voidlistChildren(List<Property> children) makeProperty(int hash, String name) voidremoveChild(String name, Base value) setActivity(List<CarePlan.CarePlanActivityComponent> theActivity) setAddresses(List<CodeableReference> theAddresses) setBasedOn(List<Reference> theBasedOn) setCareTeam(List<Reference> theCareTeam) setCategory(List<CodeableConcept> theCategory) setContributor(List<Reference> theContributor) setCreated(Date value) setCreatedElement(DateTimeType value) setCustodian(Reference value) setDescription(String value) setDescriptionElement(StringType value) setEncounter(Reference value) setIdentifier(List<Identifier> theIdentifier) setInstantiatesCanonical(List<CanonicalType> theInstantiatesCanonical) setInstantiatesUri(List<UriType> theInstantiatesUri) setIntent(CarePlan.CarePlanIntent value) setNote(List<Annotation> theNote) setProperty(int hash, String name, Base value) setProperty(String name, Base value) setReplaces(List<Reference> theReplaces) setSubject(Reference value) setSupportingInfo(List<Reference> theSupportingInfo) setTitleElement(StringType value) protected CarePlanMethods inherited from class org.hl7.fhir.r5.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getExtensionsByUrl, getExtensionString, getExtensionString, getModifierExtension, getModifierExtensionsByUrl, getStandardsStatus, getText, hasContained, hasExtension, hasExtension, hasExtension, hasModifierExtension, hasPrimitiveExtension, hasText, setContained, setExtension, setModifierExtension, setStandardsStatus, setTextMethods inherited from class org.hl7.fhir.r5.model.Resource
copyValues, getFHIRPublicationVersion, getId, getIdBase, getIdElement, getIdPart, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, getSourcePackage, getWebPath, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, hasSourcePackage, hasWebPath, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta, setSourcePackage, setWebPathMethods inherited from class org.hl7.fhir.r5.model.BaseResource
getStructureFhirVersionEnum, isResource, setIdMethods inherited from class org.hl7.fhir.r5.model.Base
addDefinition, addFormatCommentsPost, addFormatCommentsPre, addValidationMessage, canHavePrimitiveValue, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, copyFormatComments, copyUserData, copyValues, dateTimeValue, equals, executeFunction, getChildByName, getChildValueByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, getValidationInfo, getValidationMessages, getXhtml, hasFormatComment, hasFormatCommentPost, hasFormatCommentPre, hasPrimitiveValue, hasType, hasUserData, hasValidated, hasValidationInfo, hasValidationMessages, isBooleanPrimitive, isCopyUserData, isDateTime, isMetadataBased, isPrimitive, listChildrenByName, listChildrenByName, primitiveValue, setCopyUserData, setUserData, setUserDataINN, setXhtmlMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.hl7.fhir.instance.model.api.IAnyResource
getId, getIdElement, getLanguageElement, getUserData, setId, setUserDataMethods inherited from interface org.hl7.fhir.instance.model.api.IBase
getFormatCommentsPost, getFormatCommentsPre, hasFormatCommentMethods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource
getMeta, getStructureFhirVersionEnum, isDeleted, setId
-
Field Details
-
identifier
Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server. -
instantiatesCanonical
The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. -
instantiatesUri
The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan. -
basedOn
A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan. -
replaces
Completed or terminated care plan whose function is taken by this new care plan. -
partOf
A larger care plan of which this particular care plan is a component or step. -
status
Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record. -
intent
Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain. -
category
Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc. -
title
Human-friendly name for the care plan. -
description
A description of the scope and nature of the plan. -
subject
Identifies the patient or group whose intended care is described by the plan. -
encounter
The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated. -
period
Indicates when the plan did (or is intended to) come into effect and end. -
created
Represents when this particular CarePlan record was created in the system, which is often a system-generated date. -
custodian
When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian. -
contributor
Identifies the individual(s), organization or device who provided the contents of the care plan. -
careTeam
Identifies all people and organizations who are expected to be involved in the care envisioned by this plan. -
addresses
Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan. -
supportingInfo
Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc. -
goal
Describes the intended objective(s) of carrying out the care plan. -
activity
Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc. -
note
General notes about the care plan not covered elsewhere. -
SP_ACTIVITY_REFERENCE
Search parameter: activity-referenceDescription: Activity that is intended to be part of the care plan
Type: reference
Path: CarePlan.activity.plannedActivityReference
- See Also:
-
ACTIVITY_REFERENCE
Fluent Client search parameter constant for activity-referenceDescription: Activity that is intended to be part of the care plan
Type: reference
Path: CarePlan.activity.plannedActivityReference
-
INCLUDE_ACTIVITY_REFERENCE
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:activity-reference". -
SP_BASED_ON
Search parameter: based-onDescription: Fulfills CarePlan
Type: reference
Path: CarePlan.basedOn
- See Also:
-
BASED_ON
Fluent Client search parameter constant for based-onDescription: Fulfills CarePlan
Type: reference
Path: CarePlan.basedOn
-
INCLUDE_BASED_ON
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:based-on". -
SP_CARE_TEAM
Search parameter: care-teamDescription: Who's involved in plan?
Type: reference
Path: CarePlan.careTeam
- See Also:
-
CARE_TEAM
Fluent Client search parameter constant for care-teamDescription: Who's involved in plan?
Type: reference
Path: CarePlan.careTeam
-
INCLUDE_CARE_TEAM
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:care-team". -
SP_CATEGORY
Search parameter: categoryDescription: Type of plan
Type: token
Path: CarePlan.category
- See Also:
-
CATEGORY
Fluent Client search parameter constant for categoryDescription: Type of plan
Type: token
Path: CarePlan.category
-
SP_CONDITION
Search parameter: conditionDescription: Reference to a resource (by instance)
Type: reference
Path: CarePlan.addresses.reference
- See Also:
-
CONDITION
Fluent Client search parameter constant for conditionDescription: Reference to a resource (by instance)
Type: reference
Path: CarePlan.addresses.reference
-
INCLUDE_CONDITION
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:condition". -
SP_CUSTODIAN
Search parameter: custodianDescription: Who is the designated responsible party
Type: reference
Path: CarePlan.custodian
- See Also:
-
CUSTODIAN
Fluent Client search parameter constant for custodianDescription: Who is the designated responsible party
Type: reference
Path: CarePlan.custodian
-
INCLUDE_CUSTODIAN
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:custodian". -
SP_GOAL
Search parameter: goalDescription: Desired outcome of plan
Type: reference
Path: CarePlan.goal
- See Also:
-
GOAL
Fluent Client search parameter constant for goalDescription: Desired outcome of plan
Type: reference
Path: CarePlan.goal
-
INCLUDE_GOAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:goal". -
SP_INSTANTIATES_CANONICAL
Search parameter: instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: CarePlan.instantiatesCanonical
- See Also:
-
INSTANTIATES_CANONICAL
Fluent Client search parameter constant for instantiates-canonicalDescription: Instantiates FHIR protocol or definition
Type: reference
Path: CarePlan.instantiatesCanonical
-
INCLUDE_INSTANTIATES_CANONICAL
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:instantiates-canonical". -
SP_INSTANTIATES_URI
Search parameter: instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: CarePlan.instantiatesUri
- See Also:
-
INSTANTIATES_URI
Fluent Client search parameter constant for instantiates-uriDescription: Instantiates external protocol or definition
Type: uri
Path: CarePlan.instantiatesUri
-
SP_INTENT
Search parameter: intentDescription: proposal | plan | order | option | directive
Type: token
Path: CarePlan.intent
- See Also:
-
INTENT
Fluent Client search parameter constant for intentDescription: proposal | plan | order | option | directive
Type: token
Path: CarePlan.intent
-
SP_PART_OF
Search parameter: part-ofDescription: Part of referenced CarePlan
Type: reference
Path: CarePlan.partOf
- See Also:
-
PART_OF
Fluent Client search parameter constant for part-ofDescription: Part of referenced CarePlan
Type: reference
Path: CarePlan.partOf
-
INCLUDE_PART_OF
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:part-of". -
SP_REPLACES
Search parameter: replacesDescription: CarePlan replaced by this CarePlan
Type: reference
Path: CarePlan.replaces
- See Also:
-
REPLACES
Fluent Client search parameter constant for replacesDescription: CarePlan replaced by this CarePlan
Type: reference
Path: CarePlan.replaces
-
INCLUDE_REPLACES
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:replaces". -
SP_STATUS
Search parameter: statusDescription: draft | active | on-hold | revoked | completed | entered-in-error | unknown
Type: token
Path: CarePlan.status
- See Also:
-
STATUS
Fluent Client search parameter constant for statusDescription: draft | active | on-hold | revoked | completed | entered-in-error | unknown
Type: token
Path: CarePlan.status
-
SP_SUBJECT
Search parameter: subjectDescription: Who the care plan is for
Type: reference
Path: CarePlan.subject
- See Also:
-
SUBJECT
Fluent Client search parameter constant for subjectDescription: Who the care plan is for
Type: reference
Path: CarePlan.subject
-
INCLUDE_SUBJECT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:subject". -
SP_DATE
Search parameter: dateDescription: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod 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 [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn
- See Also:
-
DATE
Fluent Client search parameter constant for dateDescription: Multiple Resources: [AdverseEvent](adverseevent.html): When the event occurred [AllergyIntolerance](allergyintolerance.html): Date first version of the resource instance was recorded [Appointment](appointment.html): Appointment date/time. [AuditEvent](auditevent.html): Time when the event was recorded [CarePlan](careplan.html): Time period plan covers [CareTeam](careteam.html): A date within the coverage time period. [ClinicalImpression](clinicalimpression.html): When the assessment was documented [Composition](composition.html): Composition editing time [Consent](consent.html): When consent was agreed to [DiagnosticReport](diagnosticreport.html): The clinically relevant time of the report [DocumentReference](documentreference.html): When this document reference was created [Encounter](encounter.html): A date within the actualPeriod 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 [ImmunizationEvaluation](immunizationevaluation.html): Date the evaluation was generated [ImmunizationRecommendation](immunizationrecommendation.html): Date recommendation(s) created [Invoice](invoice.html): Invoice date / posting date [List](list.html): When the list was prepared [MeasureReport](measurereport.html): The date of the measure report [NutritionIntake](nutritionintake.html): Date when patient was taking (or not taking) the medication [Observation](observation.html): Clinically relevant time/time-period for observation [Procedure](procedure.html): When the procedure occurred or is occurring [ResearchSubject](researchsubject.html): Start and end of participation [RiskAssessment](riskassessment.html): When was assessment made? [SupplyRequest](supplyrequest.html): When the request was made
Type: date
Path: AdverseEvent.occurrence.ofType(dateTime) | AdverseEvent.occurrence.ofType(Period) | AdverseEvent.occurrence.ofType(Timing) | AllergyIntolerance.recordedDate | (start | requestedPeriod.start).first() | AuditEvent.recorded | CarePlan.period | ClinicalImpression.date | Composition.date | Consent.date | DiagnosticReport.effective.ofType(dateTime) | DiagnosticReport.effective.ofType(Period) | DocumentReference.date | Encounter.actualPeriod | EpisodeOfCare.period | FamilyMemberHistory.date | Flag.period | (Immunization.occurrence.ofType(dateTime)) | ImmunizationEvaluation.date | ImmunizationRecommendation.date | Invoice.date | List.date | MeasureReport.date | NutritionIntake.occurrence.ofType(dateTime) | NutritionIntake.occurrence.ofType(Period) | Observation.effective.ofType(dateTime) | Observation.effective.ofType(Period) | Observation.effective.ofType(Timing) | Observation.effective.ofType(instant) | Procedure.occurrence.ofType(dateTime) | Procedure.occurrence.ofType(Period) | Procedure.occurrence.ofType(Timing) | ResearchSubject.period | (RiskAssessment.occurrence.ofType(dateTime)) | SupplyRequest.authoredOn
-
SP_ENCOUNTER
Search parameter: encounterDescription: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter
- See Also:
-
ENCOUNTER
Fluent Client search parameter constant for encounterDescription: Multiple Resources: [AuditEvent](auditevent.html): Encounter related to the activity recorded in the AuditEvent [CarePlan](careplan.html): The Encounter during which this CarePlan was created [ChargeItem](chargeitem.html): Encounter associated with event [Claim](claim.html): Encounters associated with a billed line item [ClinicalImpression](clinicalimpression.html): The Encounter during which this ClinicalImpression was created [Communication](communication.html): The Encounter during which this Communication was created [CommunicationRequest](communicationrequest.html): The Encounter during which this CommunicationRequest was created [Composition](composition.html): Context of the Composition [Condition](condition.html): The Encounter during which this Condition was created [DeviceRequest](devicerequest.html): Encounter during which request was created [DiagnosticReport](diagnosticreport.html): The Encounter when the order was made [EncounterHistory](encounterhistory.html): The Encounter associated with this set of history values [ExplanationOfBenefit](explanationofbenefit.html): Encounters associated with a billed line item [Flag](flag.html): Alert relevant during encounter [ImagingStudy](imagingstudy.html): The context of the study [List](list.html): Context in which list created [MedicationDispense](medicationdispense.html): Returns dispenses with a specific encounter [MedicationStatement](medicationstatement.html): Returns statements for a specific encounter [NutritionIntake](nutritionintake.html): Returns statements for a specific encounter [NutritionOrder](nutritionorder.html): Return nutrition orders with this encounter identifier [Observation](observation.html): Encounter related to the observation [Procedure](procedure.html): The Encounter during which this Procedure was created [Provenance](provenance.html): Encounter related to the Provenance [QuestionnaireResponse](questionnaireresponse.html): Encounter associated with the questionnaire response [RequestOrchestration](requestorchestration.html): The encounter the request orchestration applies to [RiskAssessment](riskassessment.html): Where was assessment performed? [ServiceRequest](servicerequest.html): An encounter in which this request is made [Task](task.html): Search by encounter [VisionPrescription](visionprescription.html): Return prescriptions with this encounter identifier
Type: reference
Path: AuditEvent.encounter | CarePlan.encounter | ChargeItem.encounter | Claim.item.encounter | ClinicalImpression.encounter | Communication.encounter | CommunicationRequest.encounter | Composition.encounter | Condition.encounter | DeviceRequest.encounter | DiagnosticReport.encounter | EncounterHistory.encounter | ExplanationOfBenefit.item.encounter | Flag.encounter | ImagingStudy.encounter | List.encounter | MedicationDispense.encounter | MedicationStatement.encounter | NutritionIntake.encounter | NutritionOrder.encounter | Observation.encounter | Procedure.encounter | Provenance.encounter | QuestionnaireResponse.encounter | RequestOrchestration.encounter | RiskAssessment.encounter | ServiceRequest.encounter | Task.encounter | VisionPrescription.encounter
-
INCLUDE_ENCOUNTER
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:encounter". -
SP_IDENTIFIER
Search parameter: identifierDescription: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [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) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external 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 [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.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 [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier
- See Also:
-
IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Multiple Resources: [Account](account.html): Account number [AdverseEvent](adverseevent.html): Business identifier for the event [AllergyIntolerance](allergyintolerance.html): External ids for this item [Appointment](appointment.html): An Identifier of the Appointment [AppointmentResponse](appointmentresponse.html): An Identifier in this appointment response [Basic](basic.html): Business identifier [BodyStructure](bodystructure.html): Bodystructure identifier [CarePlan](careplan.html): External Ids for this plan [CareTeam](careteam.html): External Ids for this team [ChargeItem](chargeitem.html): Business Identifier for item [Claim](claim.html): The primary identifier of the financial resource [ClaimResponse](claimresponse.html): The identity of the ClaimResponse [ClinicalImpression](clinicalimpression.html): Business identifier [Communication](communication.html): Unique identifier [CommunicationRequest](communicationrequest.html): Unique identifier [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) [Contract](contract.html): The identity of the contract [Coverage](coverage.html): The primary identifier of the insured and the coverage [CoverageEligibilityRequest](coverageeligibilityrequest.html): The business identifier of the Eligibility [CoverageEligibilityResponse](coverageeligibilityresponse.html): The business identifier [DetectedIssue](detectedissue.html): Unique id for the detected issue [DeviceRequest](devicerequest.html): Business identifier for request/order [DeviceUsage](deviceusage.html): Search by identifier [DiagnosticReport](diagnosticreport.html): An identifier for the report [DocumentReference](documentreference.html): Identifier of the attachment binary [Encounter](encounter.html): Identifier(s) by which this encounter is known [EnrollmentRequest](enrollmentrequest.html): The business identifier of the Enrollment [EpisodeOfCare](episodeofcare.html): Business Identifier(s) relevant for this EpisodeOfCare [ExplanationOfBenefit](explanationofbenefit.html): The business identifier of the Explanation of Benefit [FamilyMemberHistory](familymemberhistory.html): A search by a record identifier [Flag](flag.html): Business identifier [Goal](goal.html): External Ids for this goal [GuidanceResponse](guidanceresponse.html): The identifier of the guidance response [ImagingSelection](imagingselection.html): Identifiers for the imaging selection [ImagingStudy](imagingstudy.html): Identifiers for the Study, such as DICOM Study Instance UID [Immunization](immunization.html): Business identifier [ImmunizationEvaluation](immunizationevaluation.html): ID of the evaluation [ImmunizationRecommendation](immunizationrecommendation.html): Business identifier [Invoice](invoice.html): Business Identifier for item [List](list.html): Business identifier [MeasureReport](measurereport.html): External identifier of the measure report to be returned [Medication](medication.html): Returns medications with this external 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 [MolecularSequence](molecularsequence.html): The unique identity for a particular sequence [NutritionIntake](nutritionintake.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 [Person](person.html): A person Identifier [Procedure](procedure.html): A unique identifier for a procedure [QuestionnaireResponse](questionnaireresponse.html): The unique identifier for the questionnaire response [RelatedPerson](relatedperson.html): An Identifier of the RelatedPerson [RequestOrchestration](requestorchestration.html): External identifiers for the request orchestration [ResearchSubject](researchsubject.html): Business Identifier for research subject in a study [RiskAssessment](riskassessment.html): Unique identifier for the assessment [ServiceRequest](servicerequest.html): Identifiers assigned to this order [Specimen](specimen.html): The unique identifier associated with the specimen [SupplyDelivery](supplydelivery.html): External identifier [SupplyRequest](supplyrequest.html): Business Identifier for SupplyRequest [Task](task.html): Search for a task instance by its business identifier [VisionPrescription](visionprescription.html): Return prescriptions with this external identifier
Type: token
Path: Account.identifier | AdverseEvent.identifier | AllergyIntolerance.identifier | Appointment.identifier | AppointmentResponse.identifier | Basic.identifier | BodyStructure.identifier | CarePlan.identifier | CareTeam.identifier | ChargeItem.identifier | Claim.identifier | ClaimResponse.identifier | ClinicalImpression.identifier | Communication.identifier | CommunicationRequest.identifier | Composition.identifier | Condition.identifier | Consent.identifier | Contract.identifier | Coverage.identifier | CoverageEligibilityRequest.identifier | CoverageEligibilityResponse.identifier | DetectedIssue.identifier | DeviceRequest.identifier | DeviceUsage.identifier | DiagnosticReport.identifier | DocumentReference.identifier | Encounter.identifier | EnrollmentRequest.identifier | EpisodeOfCare.identifier | ExplanationOfBenefit.identifier | FamilyMemberHistory.identifier | Flag.identifier | Goal.identifier | GuidanceResponse.identifier | ImagingSelection.identifier | ImagingStudy.identifier | Immunization.identifier | ImmunizationEvaluation.identifier | ImmunizationRecommendation.identifier | Invoice.identifier | List.identifier | MeasureReport.identifier | Medication.identifier | MedicationAdministration.identifier | MedicationDispense.identifier | MedicationRequest.identifier | MedicationStatement.identifier | MolecularSequence.identifier | NutritionIntake.identifier | NutritionOrder.identifier | Observation.identifier | Person.identifier | Procedure.identifier | QuestionnaireResponse.identifier | RelatedPerson.identifier | RequestOrchestration.identifier | ResearchSubject.identifier | RiskAssessment.identifier | ServiceRequest.identifier | Specimen.identifier | SupplyDelivery.identifier | SupplyRequest.identifier | Task.identifier | VisionPrescription.identifier
-
SP_PATIENT
Search parameter: patientDescription: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [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 [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [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 [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [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. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.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) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient
- See Also:
-
PATIENT
Fluent Client search parameter constant for patientDescription: Multiple Resources: [Account](account.html): The entity that caused the expenses [AdverseEvent](adverseevent.html): Subject impacted by event [AllergyIntolerance](allergyintolerance.html): Who the sensitivity is for [Appointment](appointment.html): One of the individuals of the appointment is this patient [AppointmentResponse](appointmentresponse.html): This Response is for this Patient [AuditEvent](auditevent.html): Where the activity involved patient data [Basic](basic.html): Identifies the focus of this resource [BodyStructure](bodystructure.html): Who this is about [CarePlan](careplan.html): Who the care plan is for [CareTeam](careteam.html): Who care team is for [ChargeItem](chargeitem.html): Individual service was done for/to [Claim](claim.html): Patient receiving the products or services [ClaimResponse](claimresponse.html): The subject of care [ClinicalImpression](clinicalimpression.html): Patient assessed [Communication](communication.html): Focus of message [CommunicationRequest](communicationrequest.html): Focus of message [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 [Contract](contract.html): The identity of the subject of the contract (if a patient) [Coverage](coverage.html): Retrieve coverages for a patient [CoverageEligibilityRequest](coverageeligibilityrequest.html): The reference to the patient [CoverageEligibilityResponse](coverageeligibilityresponse.html): The reference to the patient [DetectedIssue](detectedissue.html): Associated patient [DeviceRequest](devicerequest.html): Individual the service is ordered for [DeviceUsage](deviceusage.html): Search by patient who used / uses the device [DiagnosticReport](diagnosticreport.html): The subject of the report if a patient [DocumentReference](documentreference.html): Who/what is the subject of the document [Encounter](encounter.html): The patient present at the encounter [EnrollmentRequest](enrollmentrequest.html): The party to be enrolled [EpisodeOfCare](episodeofcare.html): The patient who is the focus of this episode of care [ExplanationOfBenefit](explanationofbenefit.html): The reference to the patient [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 [GuidanceResponse](guidanceresponse.html): The identity of a patient to search for guidance response results [ImagingSelection](imagingselection.html): Who the study is about [ImagingStudy](imagingstudy.html): Who the study is about [Immunization](immunization.html): The patient for the vaccination record [ImmunizationEvaluation](immunizationevaluation.html): The patient being evaluated [ImmunizationRecommendation](immunizationrecommendation.html): Who this profile is for [Invoice](invoice.html): Recipient(s) of goods and services [List](list.html): If all resources have the same subject [MeasureReport](measurereport.html): The identity of a patient to search for individual measure report results for [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. [MolecularSequence](molecularsequence.html): The subject that the sequence is about [NutritionIntake](nutritionintake.html): Returns statements for a specific patient. [NutritionOrder](nutritionorder.html): The identity of the individual or set of individuals who requires the diet, formula or nutritional supplement [Observation](observation.html): The subject that the observation is about (if patient) [Person](person.html): The Person links to this Patient [Procedure](procedure.html): Search by subject - a patient [Provenance](provenance.html): Where the activity involved patient data [QuestionnaireResponse](questionnaireresponse.html): The patient that is the subject of the questionnaire response [RelatedPerson](relatedperson.html): The patient this related person is related to [RequestOrchestration](requestorchestration.html): The identity of a patient to search for request orchestrations [ResearchSubject](researchsubject.html): Who or what is part of study [RiskAssessment](riskassessment.html): Who/what does assessment apply to? [ServiceRequest](servicerequest.html): Search by subject - a patient [Specimen](specimen.html): The patient the specimen comes from [SupplyDelivery](supplydelivery.html): Patient for whom the item is supplied [SupplyRequest](supplyrequest.html): The patient or subject for whom the supply is destined [Task](task.html): Search by patient [VisionPrescription](visionprescription.html): The identity of a patient to list dispenses for
Type: reference
Path: Account.subject.where(resolve() is Patient) | AdverseEvent.subject.where(resolve() is Patient) | AllergyIntolerance.patient | Appointment.participant.actor.where(resolve() is Patient) | Appointment.subject.where(resolve() is Patient) | AppointmentResponse.actor.where(resolve() is Patient) | AuditEvent.patient | Basic.subject.where(resolve() is Patient) | BodyStructure.patient | CarePlan.subject.where(resolve() is Patient) | CareTeam.subject.where(resolve() is Patient) | ChargeItem.subject.where(resolve() is Patient) | Claim.patient | ClaimResponse.patient | ClinicalImpression.subject.where(resolve() is Patient) | Communication.subject.where(resolve() is Patient) | CommunicationRequest.subject.where(resolve() is Patient) | Composition.subject.where(resolve() is Patient) | Condition.subject.where(resolve() is Patient) | Consent.subject.where(resolve() is Patient) | Contract.subject.where(resolve() is Patient) | Coverage.beneficiary | CoverageEligibilityRequest.patient | CoverageEligibilityResponse.patient | DetectedIssue.subject.where(resolve() is Patient) | DeviceRequest.subject.where(resolve() is Patient) | DeviceUsage.patient | DiagnosticReport.subject.where(resolve() is Patient) | DocumentReference.subject.where(resolve() is Patient) | Encounter.subject.where(resolve() is Patient) | EnrollmentRequest.candidate | EpisodeOfCare.patient | ExplanationOfBenefit.patient | FamilyMemberHistory.patient | Flag.subject.where(resolve() is Patient) | Goal.subject.where(resolve() is Patient) | GuidanceResponse.subject.where(resolve() is Patient) | ImagingSelection.subject.where(resolve() is Patient) | ImagingStudy.subject.where(resolve() is Patient) | Immunization.patient | ImmunizationEvaluation.patient | ImmunizationRecommendation.patient | Invoice.subject.where(resolve() is Patient) | List.subject.where(resolve() is Patient) | MeasureReport.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) | MolecularSequence.subject.where(resolve() is Patient) | NutritionIntake.subject.where(resolve() is Patient) | NutritionOrder.subject.where(resolve() is Patient) | Observation.subject.where(resolve() is Patient) | Person.link.target.where(resolve() is Patient) | Procedure.subject.where(resolve() is Patient) | Provenance.patient | QuestionnaireResponse.subject.where(resolve() is Patient) | RelatedPerson.patient | RequestOrchestration.subject.where(resolve() is Patient) | ResearchSubject.subject.where(resolve() is Patient) | RiskAssessment.subject.where(resolve() is Patient) | ServiceRequest.subject.where(resolve() is Patient) | Specimen.subject.where(resolve() is Patient) | SupplyDelivery.patient | SupplyRequest.deliverFor | Task.for.where(resolve() is Patient) | VisionPrescription.patient
-
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements. Specifies the path value of "CarePlan:patient".
-
-
Constructor Details
-
CarePlan
public CarePlan()Constructor -
CarePlan
public CarePlan(Enumerations.RequestStatus status, CarePlan.CarePlanIntent intent, Reference subject) Constructor
-
-
Method Details
-
getIdentifier
- Returns:
identifier(Business identifiers assigned to this care plan by the performer or other systems which remain constant as the resource is updated and propagates from server to server.)
-
setIdentifier
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
-
addIdentifier
-
addIdentifier
-
getIdentifierFirstRep
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist {3}
-
getInstantiatesCanonical
- Returns:
instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
setInstantiatesCanonical
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiatesCanonical
-
addInstantiatesCanonicalElement
- Returns:
instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
addInstantiatesCanonical
- Parameters:
value-instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
hasInstantiatesCanonical
- Parameters:
value-instantiatesCanonical(The URL pointing to a FHIR-defined protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
getInstantiatesUri
- Returns:
instantiatesUri(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
setInstantiatesUri
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasInstantiatesUri
-
addInstantiatesUriElement
- Returns:
instantiatesUri(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
addInstantiatesUri
- Parameters:
value-instantiatesUri(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
hasInstantiatesUri
- Parameters:
value-instantiatesUri(The URL pointing to an externally maintained protocol, guideline, questionnaire or other definition that is adhered to in whole or in part by this CarePlan.)
-
getBasedOn
- Returns:
basedOn(A higher-level request resource (i.e. a plan, proposal or order) that is fulfilled in whole or in part by this care plan.)
-
setBasedOn
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasBasedOn
-
addBasedOn
-
addBasedOn
-
getBasedOnFirstRep
- Returns:
- The first repetition of repeating field
basedOn, creating it if it does not already exist {3}
-
getReplaces
- Returns:
replaces(Completed or terminated care plan whose function is taken by this new care plan.)
-
setReplaces
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasReplaces
-
addReplaces
-
addReplaces
-
getReplacesFirstRep
- Returns:
- The first repetition of repeating field
replaces, creating it if it does not already exist {3}
-
getPartOf
- Returns:
partOf(A larger care plan of which this particular care plan is a component or step.)
-
setPartOf
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasPartOf
-
addPartOf
-
addPartOf
-
getPartOfFirstRep
- Returns:
- The first repetition of repeating field
partOf, creating it if it does not already exist {3}
-
getStatusElement
- Returns:
status(Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.). 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 whether the plan is currently being acted upon, represents future intentions or is now a historical record.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value
-
getStatus
- Returns:
- Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
setStatus
- Parameters:
value- Indicates whether the plan is currently being acted upon, represents future intentions or is now a historical record.
-
getIntentElement
- Returns:
intent(Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
hasIntentElement
-
hasIntent
-
setIntentElement
- Parameters:
value-intent(Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.). This is the underlying object with id, value and extensions. The accessor "getIntent" gives direct access to the value
-
getIntent
- Returns:
- Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
setIntent
- Parameters:
value- Indicates the level of authority/intentionality associated with the care plan and where the care plan fits into the workflow chain.
-
getCategory
- Returns:
category(Identifies what "kind" of plan this is to support differentiation between multiple co-existing plans; e.g. "Home health", "psychiatric", "asthma", "disease management", "wellness plan", etc.)
-
setCategory
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCategory
-
addCategory
-
addCategory
-
getCategoryFirstRep
- Returns:
- The first repetition of repeating field
category, creating it if it does not already exist {3}
-
getTitleElement
- Returns:
title(Human-friendly name for the care plan.). 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(Human-friendly name for the care plan.). This is the underlying object with id, value and extensions. The accessor "getTitle" gives direct access to the value
-
getTitle
- Returns:
- Human-friendly name for the care plan.
-
setTitle
- Parameters:
value- Human-friendly name for the care plan.
-
getDescriptionElement
- Returns:
description(A description of the scope and nature of the plan.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
hasDescriptionElement
-
hasDescription
-
setDescriptionElement
- Parameters:
value-description(A description of the scope and nature of the plan.). This is the underlying object with id, value and extensions. The accessor "getDescription" gives direct access to the value
-
getDescription
- Returns:
- A description of the scope and nature of the plan.
-
setDescription
- Parameters:
value- A description of the scope and nature of the plan.
-
getSubject
- Returns:
subject(Identifies the patient or group whose intended care is described by the plan.)
-
hasSubject
-
setSubject
- Parameters:
value-subject(Identifies the patient or group whose intended care is described by the plan.)
-
getEncounter
- Returns:
encounter(The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)
-
hasEncounter
-
setEncounter
- Parameters:
value-encounter(The Encounter during which this CarePlan was created or to which the creation of this record is tightly associated.)
-
getPeriod
- Returns:
period(Indicates when the plan did (or is intended to) come into effect and end.)
-
hasPeriod
-
setPeriod
- Parameters:
value-period(Indicates when the plan did (or is intended to) come into effect and end.)
-
getCreatedElement
- Returns:
created(Represents when this particular CarePlan record was created in the system, which is often a system-generated date.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
hasCreatedElement
-
hasCreated
-
setCreatedElement
- Parameters:
value-created(Represents when this particular CarePlan record was created in the system, which is often a system-generated date.). This is the underlying object with id, value and extensions. The accessor "getCreated" gives direct access to the value
-
getCreated
- Returns:
- Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
-
setCreated
- Parameters:
value- Represents when this particular CarePlan record was created in the system, which is often a system-generated date.
-
getCustodian
- Returns:
custodian(When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.)
-
hasCustodian
-
setCustodian
- Parameters:
value-custodian(When populated, the custodian is responsible for the care plan. The care plan is attributed to the custodian.)
-
getContributor
- Returns:
contributor(Identifies the individual(s), organization or device who provided the contents of the care plan.)
-
setContributor
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasContributor
-
addContributor
-
addContributor
-
getContributorFirstRep
- Returns:
- The first repetition of repeating field
contributor, creating it if it does not already exist {3}
-
getCareTeam
- Returns:
careTeam(Identifies all people and organizations who are expected to be involved in the care envisioned by this plan.)
-
setCareTeam
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasCareTeam
-
addCareTeam
-
addCareTeam
-
getCareTeamFirstRep
- Returns:
- The first repetition of repeating field
careTeam, creating it if it does not already exist {3}
-
getAddresses
- Returns:
addresses(Identifies the conditions/problems/concerns/diagnoses/etc. whose management and/or mitigation are handled by this plan.)
-
setAddresses
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasAddresses
-
addAddresses
-
addAddresses
-
getAddressesFirstRep
- Returns:
- The first repetition of repeating field
addresses, creating it if it does not already exist {3}
-
getSupportingInfo
- Returns:
supportingInfo(Identifies portions of the patient's record that specifically influenced the formation of the plan. These might include comorbidities, recent procedures, limitations, recent assessments, etc.)
-
setSupportingInfo
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasSupportingInfo
-
addSupportingInfo
-
addSupportingInfo
-
getSupportingInfoFirstRep
- Returns:
- The first repetition of repeating field
supportingInfo, creating it if it does not already exist {3}
-
getGoal
- Returns:
goal(Describes the intended objective(s) of carrying out the care plan.)
-
setGoal
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasGoal
-
addGoal
-
addGoal
-
getGoalFirstRep
- Returns:
- The first repetition of repeating field
goal, creating it if it does not already exist {3}
-
getActivity
- Returns:
activity(Identifies an action that has occurred or is a planned action to occur as part of the plan. For example, a medication to be used, lab tests to perform, self-monitoring that has occurred, education etc.)
-
setActivity
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasActivity
-
addActivity
-
addActivity
-
getActivityFirstRep
- Returns:
- The first repetition of repeating field
activity, creating it if it does not already exist {3}
-
getNote
- Returns:
note(General notes about the care plan not covered elsewhere.)
-
setNote
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasNote
-
addNote
-
addNote
-
getNoteFirstRep
- Returns:
- The first repetition of repeating field
note, creating it if it does not already exist {3}
-
listChildren
- 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
- Overrides:
setPropertyin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
removeChild
- Overrides:
removeChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
- 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
- Overrides:
addChildin classDomainResource- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
- Specified by:
fhirTypein interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
fhirTypein classDomainResource- Returns:
- the FHIR type name of the instance (not the java class name)
-
copy
- Specified by:
copyin classDomainResource
-
copyValues
-
typedCopy
-
equalsDeep
- Overrides:
equalsDeepin classDomainResource
-
equalsShallow
- Overrides:
equalsShallowin classDomainResource
-
isEmpty
- Specified by:
isEmptyin interfaceorg.hl7.fhir.instance.model.api.IBase- Overrides:
isEmptyin classDomainResource
-
getResourceType
- Specified by:
getResourceTypein classResource
-