ca.uhn.fhir.model.dstu2.resource

Class VisionPrescription

java.lang.Object

ca.uhn.fhir.model.api.BaseElement

ca.uhn.fhir.model.dstu2.resource.BaseResource

ca.uhn.fhir.model.dstu2.resource.VisionPrescription

All Implemented Interfaces:

ICompositeElement, IElement, IResource, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseResource

public class VisionPrescription
extends BaseResource
implements IResource

HAPI/FHIR VisionPrescription Resource ()

Definition: An authorization for the supply of glasses and/or contact lenses to a patient.

Requirements:

Profile Definition: http://hl7.org/fhir/profiles/VisionPrescription

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VisionPrescription.Dispense Block class for child element: VisionPrescription.dispense ()

Field Summary

Fields

Modifier and Type	Field and Description
static DateClientParam	DATEWRITTEN Fluent Client search parameter constant for datewritten
static ReferenceClientParam	ENCOUNTER Fluent Client search parameter constant for encounter
static TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static Include	INCLUDE_ENCOUNTER Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_PATIENT Constant for fluent queries to be used to add include statements.
static Include	INCLUDE_PRESCRIBER Constant for fluent queries to be used to add include statements.
static ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
static ReferenceClientParam	PRESCRIBER Fluent Client search parameter constant for prescriber
static String	SP_DATEWRITTEN Search parameter constant for datewritten
static String	SP_ENCOUNTER Search parameter constant for encounter
static String	SP_IDENTIFIER Search parameter constant for identifier
static String	SP_PATIENT Search parameter constant for patient
static String	SP_PRESCRIBER Search parameter constant for prescriber

Fields inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

RES_ID, SP_RES_ID, SP_RES_LANGUAGE

Fields inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

INCLUDE_ALL, WILDCARD_ALL_SET

Constructor Summary

Constructors

Constructor and Description
VisionPrescription()

Method Summary

Modifier and Type	Method and Description
VisionPrescription.Dispense	addDispense() Adds and returns a new value for dispense ()
VisionPrescription	addDispense(VisionPrescription.Dispense theValue) Adds a given new value for dispense ()
IdentifierDt	addIdentifier() Adds and returns a new value for identifier ()
VisionPrescription	addIdentifier(IdentifierDt theValue) Adds a given new value for identifier ()
<T extends IElement> List<T>	getAllPopulatedChildElementsOfType(Class<T> theType)
Date	getDateWritten() Gets the value(s) for dateWritten ().
DateTimeDt	getDateWrittenElement() Gets the value(s) for dateWritten ().
List<VisionPrescription.Dispense>	getDispense() Gets the value(s) for dispense ().
VisionPrescription.Dispense	getDispenseFirstRep() Gets the first repetition for dispense (), creating it if it does not already exist.
ResourceReferenceDt	getEncounter() Gets the value(s) for encounter ().
List<IdentifierDt>	getIdentifier() Gets the value(s) for identifier ().
IdentifierDt	getIdentifierFirstRep() Gets the first repetition for identifier (), creating it if it does not already exist.
ResourceReferenceDt	getPatient() Gets the value(s) for patient ().
ResourceReferenceDt	getPrescriber() Gets the value(s) for prescriber ().
IDatatype	getReason() Gets the value(s) for reason[x] ().
String	getResourceName()
FhirVersionEnum	getStructureFhirVersionEnum()
boolean	isEmpty()
VisionPrescription	setDateWritten(Date theDate, TemporalPrecisionEnum thePrecision) Sets the value for dateWritten ()
VisionPrescription	setDateWritten(DateTimeDt theValue) Sets the value(s) for dateWritten ()
VisionPrescription	setDateWrittenWithSecondsPrecision(Date theDate) Sets the value for dateWritten ()
VisionPrescription	setDispense(List<VisionPrescription.Dispense> theValue) Sets the value(s) for dispense ()
VisionPrescription	setEncounter(ResourceReferenceDt theValue) Sets the value(s) for encounter ()
VisionPrescription	setIdentifier(List<IdentifierDt> theValue) Sets the value(s) for identifier ()
VisionPrescription	setPatient(ResourceReferenceDt theValue) Sets the value(s) for patient ()
VisionPrescription	setPrescriber(ResourceReferenceDt theValue) Sets the value(s) for prescriber ()
VisionPrescription	setReason(IDatatype theValue) Sets the value(s) for reason[x] ()

Methods inherited from class ca.uhn.fhir.model.dstu2.resource.BaseResource

getContained, getId, getIdElement, getLanguage, getResourceMetadata, getText, isBaseEmpty, setContained, setId, setId, setId, setLanguage, setResourceMetadata, setText, toString

Methods inherited from class ca.uhn.fhir.model.api.BaseElement

addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ca.uhn.fhir.model.api.IResource

getContained, getId, getLanguage, getResourceMetadata, getText, setId, setLanguage, setResourceMetadata

Methods inherited from interface org.hl7.fhir.instance.model.api.IBaseResource

getIdElement, setId, setId

Field Detail

SP_DATEWRITTEN

public static final String SP_DATEWRITTEN

Search parameter constant for datewritten

Description: Return prescriptions written on this date
Type: date
Path: VisionPrescription.dateWritten

See Also:

Constant Field Values

DATEWRITTEN

public static final DateClientParam DATEWRITTEN

Fluent Client search parameter constant for datewritten

Description: Return prescriptions written on this date
Type: date
Path: VisionPrescription.dateWritten

SP_ENCOUNTER

public static final String SP_ENCOUNTER

Search parameter constant for encounter

Description: Return prescriptions with this encounter identifier
Type: reference
Path: VisionPrescription.encounter

See Also:

Constant Field Values

ENCOUNTER

public static final ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

Description: Return prescriptions with this encounter identifier
Type: reference
Path: VisionPrescription.encounter

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter constant for identifier

Description: Return prescriptions with this external identifier
Type: token
Path: VisionPrescription.identifier

See Also:

Constant Field Values

IDENTIFIER

public static final TokenClientParam IDENTIFIER

Fluent Client search parameter constant for identifier

Description: Return prescriptions with this external identifier
Type: token
Path: VisionPrescription.identifier

SP_PATIENT

public static final String SP_PATIENT

Search parameter constant for patient

Description: The identity of a patient to list dispenses for
Type: reference
Path: VisionPrescription.patient

See Also:

Constant Field Values

PATIENT

public static final ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

Description: The identity of a patient to list dispenses for
Type: reference
Path: VisionPrescription.patient

SP_PRESCRIBER

public static final String SP_PRESCRIBER

Search parameter constant for prescriber

Description:
Type: reference
Path: VisionPrescription.prescriber

See Also:

Constant Field Values

PRESCRIBER

public static final ReferenceClientParam PRESCRIBER

Fluent Client search parameter constant for prescriber

Description:
Type: reference
Path: VisionPrescription.prescriber

INCLUDE_ENCOUNTER

public static final Include INCLUDE_ENCOUNTER

Constant for fluent queries to be used to add include statements. Specifies the path value of "VisionPrescription:encounter".

INCLUDE_PATIENT

public static final Include INCLUDE_PATIENT

Constant for fluent queries to be used to add include statements. Specifies the path value of "VisionPrescription:patient".

INCLUDE_PRESCRIBER

public static final Include INCLUDE_PRESCRIBER

Constant for fluent queries to be used to add include statements. Specifies the path value of "VisionPrescription:prescriber".

Constructor Detail

VisionPrescription

public VisionPrescription()

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IBase

getAllPopulatedChildElementsOfType

public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)

Specified by:

getAllPopulatedChildElementsOfType in interface ICompositeElement

getIdentifier

public List<IdentifierDt> getIdentifier()

Gets the value(s) for identifier (). creating it if it does not exist. Will not return null.

Definition: Business identifier which may be used by other parties to reference or identify the prescription.

setIdentifier

public VisionPrescription setIdentifier(List<IdentifierDt> theValue)

Sets the value(s) for identifier ()

Definition: Business identifier which may be used by other parties to reference or identify the prescription.

addIdentifier

public IdentifierDt addIdentifier()

Adds and returns a new value for identifier ()

Definition: Business identifier which may be used by other parties to reference or identify the prescription.

addIdentifier

public VisionPrescription addIdentifier(IdentifierDt theValue)

Adds a given new value for identifier ()

Definition: Business identifier which may be used by other parties to reference or identify the prescription.

Parameters:

theValue - The identifier to add (must not be null)

getIdentifierFirstRep

public IdentifierDt getIdentifierFirstRep()

Gets the first repetition for identifier (), creating it if it does not already exist.

Definition: Business identifier which may be used by other parties to reference or identify the prescription.

getDateWrittenElement

public DateTimeDt getDateWrittenElement()

Gets the value(s) for dateWritten (). creating it if it does not exist. Will not return null.

Definition: The date (and perhaps time) when the prescription was written

getDateWritten

public Date getDateWritten()

Gets the value(s) for dateWritten (). creating it if it does not exist. Will not return null.

Definition: The date (and perhaps time) when the prescription was written

setDateWritten

public VisionPrescription setDateWritten(DateTimeDt theValue)

Sets the value(s) for dateWritten ()

Definition: The date (and perhaps time) when the prescription was written

setDateWritten

public VisionPrescription setDateWritten(Date theDate,
                                         TemporalPrecisionEnum thePrecision)

Sets the value for dateWritten ()

Definition: The date (and perhaps time) when the prescription was written

setDateWrittenWithSecondsPrecision

public VisionPrescription setDateWrittenWithSecondsPrecision(Date theDate)

Sets the value for dateWritten ()

Definition: The date (and perhaps time) when the prescription was written

getPatient

public ResourceReferenceDt getPatient()

Gets the value(s) for patient (). creating it if it does not exist. Will not return null.

Definition: A link to a resource representing the person to whom the vision products will be supplied.

setPatient

public VisionPrescription setPatient(ResourceReferenceDt theValue)

Sets the value(s) for patient ()

Definition: A link to a resource representing the person to whom the vision products will be supplied.

getPrescriber

public ResourceReferenceDt getPrescriber()

Gets the value(s) for prescriber (). creating it if it does not exist. Will not return null.

Definition: The healthcare professional responsible for authorizing the prescription

setPrescriber

public VisionPrescription setPrescriber(ResourceReferenceDt theValue)

Sets the value(s) for prescriber ()

Definition: The healthcare professional responsible for authorizing the prescription

getEncounter

public ResourceReferenceDt getEncounter()

Gets the value(s) for encounter (). creating it if it does not exist. Will not return null.

Definition: A link to a resource that identifies the particular occurrence of contact between patient and health care provider.

setEncounter

public VisionPrescription setEncounter(ResourceReferenceDt theValue)

Sets the value(s) for encounter ()

Definition: A link to a resource that identifies the particular occurrence of contact between patient and health care provider.

getReason

public IDatatype getReason()

Gets the value(s) for reason[x] (). creating it if it does not exist. Will not return null.

Definition: Can be the reason or the indication for writing the prescription.

setReason

public VisionPrescription setReason(IDatatype theValue)

Sets the value(s) for reason[x] ()

Definition: Can be the reason or the indication for writing the prescription.

getDispense

public List<VisionPrescription.Dispense> getDispense()

Gets the value(s) for dispense (). creating it if it does not exist. Will not return null.

Definition: Deals with details of the dispense part of the supply specification.

setDispense

public VisionPrescription setDispense(List<VisionPrescription.Dispense> theValue)

Sets the value(s) for dispense ()

Definition: Deals with details of the dispense part of the supply specification.

addDispense

public VisionPrescription.Dispense addDispense()

Adds and returns a new value for dispense ()

Definition: Deals with details of the dispense part of the supply specification.

addDispense

public VisionPrescription addDispense(VisionPrescription.Dispense theValue)

Adds a given new value for dispense ()

Definition: Deals with details of the dispense part of the supply specification.

Parameters:

theValue - The dispense to add (must not be null)

getDispenseFirstRep

public VisionPrescription.Dispense getDispenseFirstRep()

Gets the first repetition for dispense (), creating it if it does not already exist.

Definition: Deals with details of the dispense part of the supply specification.

getResourceName

public String getResourceName()

Specified by:

getResourceName in interface IResource

getStructureFhirVersionEnum

public FhirVersionEnum getStructureFhirVersionEnum()

Specified by:

getStructureFhirVersionEnum in interface IResource

Specified by:

getStructureFhirVersionEnum in interface IBaseResource