
Class ImmunizationRecommendation
- java.lang.Object
-
- org.hl7.fhir.dstu3.model.Base
-
- org.hl7.fhir.dstu3.model.BaseResource
-
- org.hl7.fhir.dstu3.model.Resource
-
- org.hl7.fhir.dstu3.model.DomainResource
-
- org.hl7.fhir.dstu3.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 immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent
static class
ImmunizationRecommendation.ImmunizationRecommendationRecommendationDateCriterionComponent
static class
ImmunizationRecommendation.ImmunizationRecommendationRecommendationProtocolComponent
-
Field Summary
Fields Modifier and Type Field Description static ca.uhn.fhir.rest.gclient.DateClientParam
DATE
Fluent Client search parameter constant for datestatic ca.uhn.fhir.rest.gclient.NumberClientParam
DOSE_NUMBER
Fluent Client search parameter constant for dose-numberstatic ca.uhn.fhir.rest.gclient.NumberClientParam
DOSE_SEQUENCE
Fluent Client search parameter constant for dose-sequenceprotected List<Identifier>
identifier
A unique identifier assigned to this particular recommendation record.static ca.uhn.fhir.rest.gclient.TokenClientParam
IDENTIFIER
Fluent Client search parameter constant for identifierstatic ca.uhn.fhir.model.api.Include
INCLUDE_INFORMATION
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_PATIENT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.model.api.Include
INCLUDE_SUPPORT
Constant for fluent queries to be used to add include statements.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
INFORMATION
Fluent Client search parameter constant for informationprotected Reference
patient
The patient the recommendations are for.static ca.uhn.fhir.rest.gclient.ReferenceClientParam
PATIENT
Fluent Client search parameter constant for patientprotected Patient
patientTarget
The actual object that is the target of the reference (The patient the recommendations are for.)protected List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent>
recommendation
Vaccine administration recommendations.static String
SP_DATE
Search parameter: datestatic String
SP_DOSE_NUMBER
Search parameter: dose-numberstatic String
SP_DOSE_SEQUENCE
Search parameter: dose-sequencestatic String
SP_IDENTIFIER
Search parameter: identifierstatic String
SP_INFORMATION
Search parameter: informationstatic String
SP_PATIENT
Search parameter: patientstatic String
SP_STATUS
Search parameter: statusstatic String
SP_SUPPORT
Search parameter: supportstatic String
SP_TARGET_DISEASE
Search parameter: target-diseasestatic String
SP_VACCINE_TYPE
Search parameter: vaccine-typestatic ca.uhn.fhir.rest.gclient.TokenClientParam
STATUS
Fluent Client search parameter constant for statusstatic ca.uhn.fhir.rest.gclient.ReferenceClientParam
SUPPORT
Fluent Client search parameter constant for supportstatic ca.uhn.fhir.rest.gclient.TokenClientParam
TARGET_DISEASE
Fluent Client search parameter constant for target-diseasestatic ca.uhn.fhir.rest.gclient.TokenClientParam
VACCINE_TYPE
Fluent Client search parameter constant for vaccine-type-
Fields inherited from class org.hl7.fhir.dstu3.model.DomainResource
contained, extension, modifierExtension, text
-
Fields inherited from class org.hl7.fhir.dstu3.model.Resource
id, implicitRules, language, meta
-
-
Constructor Summary
Constructors Constructor Description ImmunizationRecommendation()
ConstructorImmunizationRecommendation(Reference patient)
Constructor
-
Method Summary
-
Methods inherited from class org.hl7.fhir.dstu3.model.DomainResource
addContained, addExtension, addExtension, addModifierExtension, addModifierExtension, copyValues, getContained, getExtension, getExtensionsByUrl, getModifierExtension, getModifierExtensionsByUrl, getText, hasContained, hasExtension, hasModifierExtension, hasText, setContained, setExtension, setModifierExtension, setText
-
Methods inherited from class org.hl7.fhir.dstu3.model.Resource
copyValues, getId, getIdBase, getIdElement, getImplicitRules, getImplicitRulesElement, 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.dstu3.model.BaseResource
getStructureFhirVersionEnum, isResource, setId
-
Methods inherited from class org.hl7.fhir.dstu3.model.Base
castToAddress, castToAnnotation, castToAttachment, castToBase64Binary, castToBoolean, castToCode, castToCodeableConcept, castToCoding, castToContactDetail, castToContactPoint, castToContributor, castToDataRequirement, castToDate, castToDateTime, castToDecimal, castToDosage, castToDuration, castToElementDefinition, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, castToPositiveInt, castToQuantity, castToRange, castToRatio, castToReference, castToRelatedArtifact, castToResource, castToSampledData, castToSignature, castToSimpleQuantity, castToString, castToTime, castToTiming, castToTriggerDefinition, castToType, castToUnsignedInt, castToUri, castToUsageContext, castToXhtml, castToXhtmlString, children, clearUserData, compareDeep, compareDeep, compareDeep, compareValues, compareValues, equals, getChildByName, getFormatCommentsPost, getFormatCommentsPre, getNamedProperty, getUserData, getUserInt, getUserString, hasFormatComment, hasPrimitiveValue, hasType, hasUserData, isBooleanPrimitive, 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 recommendations are for.)
-
recommendation
protected List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent> recommendation
Vaccine administration recommendations.
-
SP_DATE
public static final String SP_DATE
Search parameter: dateDescription: Date recommendation created
Type: date
Path: ImmunizationRecommendation.recommendation.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 created
Type: date
Path: ImmunizationRecommendation.recommendation.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_DOSE_SEQUENCE
public static final String SP_DOSE_SEQUENCE
Search parameter: dose-sequenceDescription: Dose number within sequence
Type: number
Path: ImmunizationRecommendation.recommendation.protocol.doseSequence
- See Also:
- Constant Field Values
-
DOSE_SEQUENCE
public static final ca.uhn.fhir.rest.gclient.NumberClientParam DOSE_SEQUENCE
Fluent Client search parameter constant for dose-sequenceDescription: Dose number within sequence
Type: number
Path: ImmunizationRecommendation.recommendation.protocol.doseSequence
-
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 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 recommendation applies to
Type: token
Path: ImmunizationRecommendation.recommendation.vaccineCode
-
SP_DOSE_NUMBER
public static final String SP_DOSE_NUMBER
Search parameter: dose-numberDescription: Recommended dose number
Type: number
Path: ImmunizationRecommendation.recommendation.doseNumber
- See Also:
- Constant Field Values
-
DOSE_NUMBER
public static final ca.uhn.fhir.rest.gclient.NumberClientParam DOSE_NUMBER
Fluent Client search parameter constant for dose-numberDescription: Recommended dose number
Type: number
Path: ImmunizationRecommendation.recommendation.doseNumber
-
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 administration 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 administration status
Type: token
Path: ImmunizationRecommendation.recommendation.forecastStatus
-
-
Constructor Detail
-
ImmunizationRecommendation
public ImmunizationRecommendation()
Constructor
-
ImmunizationRecommendation
public ImmunizationRecommendation(Reference patient)
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
this
for 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 recommendations are for.)
-
hasPatient
public boolean hasPatient()
-
setPatient
public ImmunizationRecommendation setPatient(Reference value)
- Parameters:
value
-patient
(The patient the recommendations are for.)
-
getPatientTarget
public Patient getPatientTarget()
- Returns:
patient
The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (The patient the recommendations are for.)
-
setPatientTarget
public ImmunizationRecommendation setPatientTarget(Patient value)
- Parameters:
value
-patient
The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (The patient the recommendations are for.)
-
getRecommendation
public List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent> getRecommendation()
- Returns:
recommendation
(Vaccine administration recommendations.)
-
setRecommendation
public ImmunizationRecommendation setRecommendation(List<ImmunizationRecommendation.ImmunizationRecommendationRecommendationComponent> theRecommendation)
- Returns:
- Returns a reference to
this
for 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:
listChildren
in classDomainResource
-
getNamedProperty
public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getNamedProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getProperty
public Base[] getProperty(int hash, String name, boolean checkValid) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
setProperty
public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
setProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
makeProperty
public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
makeProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
getTypesForProperty
public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
getTypesForProperty
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
addChild
public Base addChild(String name) throws org.hl7.fhir.exceptions.FHIRException
- Overrides:
addChild
in classDomainResource
- Throws:
org.hl7.fhir.exceptions.FHIRException
-
fhirType
public String fhirType()
- Specified by:
fhirType
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
fhirType
in classDomainResource
-
copy
public ImmunizationRecommendation copy()
- Specified by:
copy
in classDomainResource
-
typedCopy
protected ImmunizationRecommendation typedCopy()
-
equalsDeep
public boolean equalsDeep(Base other_)
- Overrides:
equalsDeep
in classDomainResource
-
equalsShallow
public boolean equalsShallow(Base other_)
- Overrides:
equalsShallow
in classDomainResource
-
isEmpty
public boolean isEmpty()
- Specified by:
isEmpty
in interfaceorg.hl7.fhir.instance.model.api.IBase
- Overrides:
isEmpty
in classDomainResource
-
getResourceType
public ResourceType getResourceType()
- Specified by:
getResourceType
in classResource
-
-