Class ImmunizationRecommendation
- java.lang.Object
-
- org.hl7.fhir.r4.model.Base
-
- org.hl7.fhir.r4.model.BaseResource
-
- org.hl7.fhir.r4.model.Resource
-
- org.hl7.fhir.r4.model.DomainResource
-
- org.hl7.fhir.r4.model.ImmunizationRecommendation
-
- 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 ImmunizationRecommendation extends DomainResource
A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classImmunizationRecommendation.ImmunizationRecommendationRecommendationComponentstatic classImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent
-
Field Summary
Fields Modifier and Type Field Description protected ReferenceauthorityIndicates the authority who published the protocol (e.g.protected OrganizationauthorityTargetThe actual object that is the target of the reference (Indicates the authority who published the protocol (e.g.protected DateTimeTypedateThe date the immunization recommendation(s) were created.static ca.uhn.fhir.rest.gclient.DateClientParamDATEFluent Client search parameter constant for dateprotected List<Identifier>identifierA unique identifier assigned to this particular recommendation record.static ca.uhn.fhir.rest.gclient.TokenClientParamIDENTIFIERFluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.IncludeINCLUDE_INFORMATIONConstant 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_SUPPORTConstant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParamINFORMATIONFluent Client search parameter constant for informationprotected ReferencepatientThe patient the recommendation(s) are for.static ca.uhn.fhir.rest.gclient.ReferenceClientParamPATIENTFluent Client search parameter constant for patientprotected PatientpatientTargetThe actual object that is the target of the reference (The patient the recommendation(s) are for.)protected List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent>recommendationVaccine administration recommendations.static StringSP_DATESearch parameter: datestatic StringSP_IDENTIFIERSearch parameter: identifierstatic StringSP_INFORMATIONSearch parameter: informationstatic StringSP_PATIENTSearch parameter: patientstatic StringSP_STATUSSearch parameter: statusstatic StringSP_SUPPORTSearch parameter: supportstatic StringSP_TARGET_DISEASESearch parameter: target-diseasestatic StringSP_VACCINE_TYPESearch parameter: vaccine-typestatic ca.uhn.fhir.rest.gclient.TokenClientParamSTATUSFluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.ReferenceClientParamSUPPORTFluent Client search parameter constant for supportstatic ca.uhn.fhir.rest.gclient.TokenClientParamTARGET_DISEASEFluent Client search parameter constant for target-diseasestatic ca.uhn.fhir.rest.gclient.TokenClientParamVACCINE_TYPEFluent Client search parameter constant for vaccine-type-
Fields inherited from class org.hl7.fhir.r4.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.r4.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ImmunizationRecommendation()ConstructorImmunizationRecommendation(Reference patient, DateTimeType date)Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.r4.model.DomainResource
addContained, addExtension, addExtension, addExtension, addModifierExtension, addModifierExtension, checkNoModifiers, copyValues, getContained, getExtension, getExtensionByUrl, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.r4.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, getLanguage, getLanguage, getLanguageElement, getMeta, hasId, hasIdElement, hasImplicitRules, hasImplicitRulesElement, hasLanguage, hasLanguageElement, hasMeta, setId, setIdBase, setIdElement, setImplicitRules, setImplicitRulesElement, setLanguage, setLanguageElement, setMeta
-
Methods inherited from class org.hl7.fhir.r4.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.r4.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCanonical, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExpression, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPopulation, castToPositiveInt, castToProdCharacteristic, castToProductShelfLife, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToSubstanceAmount, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUrl, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareDeep, compareValues, compareValues, dateTimeValue, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, 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
A unique identifier assigned to this particular recommendation record.
-
patientTarget
protected Patient patientTarget
The actual object that is the target of the reference (The patient the recommendation(s) are for.)
-
date
protected DateTimeType date
The date the immunization recommendation(s) were created.
-
authority
protected Reference authority
Indicates the authority who published the protocol (e.g. ACIP).
-
authorityTarget
protected Organization authorityTarget
The actual object that is the target of the reference (Indicates the authority who published the protocol (e.g. ACIP).)
-
recommendation
protected List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent> recommendation
Vaccine administration recommendations.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Date recommendation(s) created
Type: date
Path: ImmunizationRecommendation.date
- See Also:
- Constant Field Values
-
DATE
public static final ca.uhn.fhir.rest.gclient.DateClientParam DATE
Fluent Client search parameter constant for dateDescription: Date recommendation(s) created
Type: date
Path: ImmunizationRecommendation.date
-
SP_IDENTIFIER
public static final String SP_IDENTIFIER
Search parameter: identifierDescription: Business identifier
Type: token
Path: ImmunizationRecommendation.identifier
- See Also:
- Constant Field Values
-
IDENTIFIER
public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
Fluent Client search parameter constant for identifierDescription: Business identifier
Type: token
Path: ImmunizationRecommendation.identifier
-
SP_TARGET_DISEASE
public static final String SP_TARGET_DISEASE
Search parameter: target-diseaseDescription: Disease to be immunized against
Type: token
Path: ImmunizationRecommendation.recommendation.targetDisease
- See Also:
- Constant Field Values
-
TARGET_DISEASE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam TARGET_DISEASE
Fluent Client search parameter constant for target-diseaseDescription: Disease to be immunized against
Type: token
Path: ImmunizationRecommendation.recommendation.targetDisease
-
SP_PATIENT
public static final String SP_PATIENT
Search parameter: patientDescription: Who this profile is for
Type: reference
Path: ImmunizationRecommendation.patient
- See Also:
- Constant Field Values
-
PATIENT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT
Fluent Client search parameter constant for patientDescription: Who this profile is for
Type: reference
Path: ImmunizationRecommendation.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 "ImmunizationRecommendation:patient".
-
SP_VACCINE_TYPE
public static final String SP_VACCINE_TYPE
Search parameter: vaccine-typeDescription: Vaccine or vaccine group recommendation applies to
Type: token
Path: ImmunizationRecommendation.recommendation.vaccineCode
- See Also:
- Constant Field Values
-
VACCINE_TYPE
public static final ca.uhn.fhir.rest.gclient.TokenClientParam VACCINE_TYPE
Fluent Client search parameter constant for vaccine-typeDescription: Vaccine or vaccine group recommendation applies to
Type: token
Path: ImmunizationRecommendation.recommendation.vaccineCode
-
SP_INFORMATION
public static final String SP_INFORMATION
Search parameter: informationDescription: Patient observations supporting recommendation
Type: reference
Path: ImmunizationRecommendation.recommendation.supportingPatientInformation
- See Also:
- Constant Field Values
-
INFORMATION
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam INFORMATION
Fluent Client search parameter constant for informationDescription: Patient observations supporting recommendation
Type: reference
Path: ImmunizationRecommendation.recommendation.supportingPatientInformation
-
INCLUDE_INFORMATION
public static final ca.uhn.fhir.model.api.Include INCLUDE_INFORMATION
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationRecommendation:information".
-
SP_SUPPORT
public static final String SP_SUPPORT
Search parameter: supportDescription: Past immunizations supporting recommendation
Type: reference
Path: ImmunizationRecommendation.recommendation.supportingImmunization
- See Also:
- Constant Field Values
-
SUPPORT
public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam SUPPORT
Fluent Client search parameter constant for supportDescription: Past immunizations supporting recommendation
Type: reference
Path: ImmunizationRecommendation.recommendation.supportingImmunization
-
INCLUDE_SUPPORT
public static final ca.uhn.fhir.model.api.Include INCLUDE_SUPPORT
Constant for fluent queries to be used to add include statements. Specifies the path value of "ImmunizationRecommendation:support".
-
SP_STATUS
public static final String SP_STATUS
Search parameter: statusDescription: Vaccine recommendation status
Type: token
Path: ImmunizationRecommendation.recommendation.forecastStatus
- See Also:
- Constant Field Values
-
STATUS
public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
Fluent Client search parameter constant for statusDescription: Vaccine recommendation status
Type: token
Path: ImmunizationRecommendation.recommendation.forecastStatus
-
-
Constructor Detail
-
ImmunizationRecommendation
public ImmunizationRecommendation()
Constructor
-
ImmunizationRecommendation
public ImmunizationRecommendation(Reference patient, DateTimeType date)
Constructor
-
-
Method Detail
-
getIdentifier
public List<Identifier> getIdentifier()
- Returns:
identifier(A unique identifier assigned to this particular recommendation record.)
-
setIdentifier
public ImmunizationRecommendation setIdentifier(List<Identifier> theIdentifier)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasIdentifier
public boolean hasIdentifier()
-
addIdentifier
public Identifier addIdentifier()
-
addIdentifier
public ImmunizationRecommendation addIdentifier(Identifier t)
-
getIdentifierFirstRep
public Identifier getIdentifierFirstRep()
- Returns:
- The first repetition of repeating field
identifier, creating it if it does not already exist
-
getPatient
public Reference getPatient()
- Returns:
patient(The patient the recommendation(s) are for.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public ImmunizationRecommendation setPatient(Reference value)
- Parameters:
value-patient(The patient the recommendation(s) are for.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patientThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient the recommendation(s) are for.)
-
setPatientTarget
public ImmunizationRecommendation setPatientTarget(Patient value)
- Parameters:
value-patientThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient the recommendation(s) are for.)
-
getDateElement
public DateTimeType getDateElement()
- Returns:
date(The date the immunization recommendation(s) were created.). 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 ImmunizationRecommendation setDateElement(DateTimeType value)
- Parameters:
value-date(The date the immunization recommendation(s) were created.). This is the underlying object with id, value and extensions. The accessor "getDate" gives direct access to the value
-
setDate
public ImmunizationRecommendation setDate(Date value)
- Parameters:
value- The date the immunization recommendation(s) were created.
-
getAuthority
public Reference getAuthority()
- Returns:
authority(Indicates the authority who published the protocol (e.g. ACIP).)
-
hasAuthority
public boolean hasAuthority()
-
setAuthority
public ImmunizationRecommendation setAuthority(Reference value)
- Parameters:
value-authority(Indicates the authority who published the protocol (e.g. ACIP).)
-
getAuthorityTarget
public Organization getAuthorityTarget()
- Returns:
authorityThe actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (Indicates the authority who published the protocol (e.g. ACIP).)
-
setAuthorityTarget
public ImmunizationRecommendation setAuthorityTarget(Organization value)
- Parameters:
value-authorityThe actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (Indicates the authority who published the protocol (e.g. ACIP).)
-
getRecommendation
public List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent> getRecommendation()
- Returns:
recommendation(Vaccine administration recommendations.)
-
setRecommendation
public ImmunizationRecommendation setRecommendation(List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent> theRecommendation)
- Returns:
- Returns a reference to
thisfor easy method chaining
-
hasRecommendation
public boolean hasRecommendation()
-
addRecommendation
public ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent addRecommendation()
-
addRecommendation
public ImmunizationRecommendation addRecommendation(ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent t)
-
getRecommendationFirstRep
public ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent getRecommendationFirstRep()
- Returns:
- The first repetition of repeating field
recommendation, creating it if it does not already exist
-
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 ImmunizationRecommendation copy()
- Specified by:
copyin classDomainResource
-
copyValues
public void copyValues(ImmunizationRecommendation dst)
-
typedCopy
protected ImmunizationRecommendation 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
-
-