org.hl7.fhir.r4.model

Class VisionPrescription

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.VisionPrescription

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 VisionPrescription
extends DomainResource

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VisionPrescription.PrismComponent
static class	VisionPrescription.VisionBase
static class	VisionPrescription.VisionBaseEnumFactory
static class	VisionPrescription.VisionEyes
static class	VisionPrescription.VisionEyesEnumFactory
static class	VisionPrescription.VisionPrescriptionDispenseComponent
static class	VisionPrescription.VisionStatus
static class	VisionPrescription.VisionStatusEnumFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected DateTimeType	dateWritten The date (and perhaps time) when the prescription was written.
static ca.uhn.fhir.rest.gclient.DateClientParam	DATEWRITTEN Fluent Client search parameter constant for datewritten
protected List<VisionPrescription.VisionPrescriptionDispenseComponent>	dispense Deals with details of the dispense part of the supply specification.
protected Reference	encounter A link to a resource that identifies the particular occurrence of contact between patient and health care provider.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	ENCOUNTER Fluent Client search parameter constant for encounter
protected Encounter	encounterTarget The actual object that is the target of the reference (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)
protected List<Identifier>	identifier Business identifier which may be used by other parties to reference or identify the prescription.
static ca.uhn.fhir.rest.gclient.TokenClientParam	IDENTIFIER Fluent Client search parameter constant for identifier
static ca.uhn.fhir.model.api.Include	INCLUDE_ENCOUNTER 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_PRESCRIBER Constant for fluent queries to be used to add include statements.
protected Reference	patient A link to a resource representing the person to whom the vision products will be supplied.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PATIENT Fluent Client search parameter constant for patient
protected Patient	patientTarget The actual object that is the target of the reference (A link to a resource representing the person to whom the vision products will be supplied.)
protected Reference	prescriber The healthcare professional responsible for authorizing the prescription.
static ca.uhn.fhir.rest.gclient.ReferenceClientParam	PRESCRIBER Fluent Client search parameter constant for prescriber
protected Resource	prescriberTarget The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.)
protected Type	reason Can be the reason or the indication for writing the prescription.
static String	SP_DATEWRITTEN Search parameter: datewritten
static String	SP_ENCOUNTER Search parameter: encounter
static String	SP_IDENTIFIER Search parameter: identifier
static String	SP_PATIENT Search parameter: patient
static String	SP_PRESCRIBER Search parameter: prescriber
static String	SP_STATUS Search parameter: status
protected Enumeration<VisionPrescription.VisionStatus>	status The status of the resource instance.
static ca.uhn.fhir.rest.gclient.TokenClientParam	STATUS Fluent Client search parameter constant for status

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

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

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() Constructor

Method Summary

Modifier and Type	Method and Description
Base	addChild(String name)
VisionPrescription.VisionPrescriptionDispenseComponent	addDispense()
VisionPrescription	addDispense(VisionPrescription.VisionPrescriptionDispenseComponent t)
Identifier	addIdentifier()
VisionPrescription	addIdentifier(Identifier t)
VisionPrescription	copy()
boolean	equalsDeep(Base other_)
boolean	equalsShallow(Base other_)
String	fhirType()
Date	getDateWritten()
DateTimeType	getDateWrittenElement()
List<VisionPrescription.VisionPrescriptionDispenseComponent>	getDispense()
VisionPrescription.VisionPrescriptionDispenseComponent	getDispenseFirstRep()
Reference	getEncounter()
Encounter	getEncounterTarget()
List<Identifier>	getIdentifier()
Identifier	getIdentifierFirstRep()
Property	getNamedProperty(int _hash, String _name, boolean _checkValid)
Reference	getPatient()
Patient	getPatientTarget()
Reference	getPrescriber()
Resource	getPrescriberTarget()
Base[]	getProperty(int hash, String name, boolean checkValid)
Type	getReason()
CodeableConcept	getReasonCodeableConcept()
Reference	getReasonReference()
ResourceType	getResourceType()
VisionPrescription.VisionStatus	getStatus()
Enumeration<VisionPrescription.VisionStatus>	getStatusElement()
String[]	getTypesForProperty(int hash, String name)
boolean	hasDateWritten()
boolean	hasDateWrittenElement()
boolean	hasDispense()
boolean	hasEncounter()
boolean	hasIdentifier()
boolean	hasPatient()
boolean	hasPrescriber()
boolean	hasReason()
boolean	hasReasonCodeableConcept()
boolean	hasReasonReference()
boolean	hasStatus()
boolean	hasStatusElement()
boolean	isEmpty()
protected void	listChildren(List<Property> children)
Base	makeProperty(int hash, String name)
VisionPrescription	setDateWritten(Date value)
VisionPrescription	setDateWrittenElement(DateTimeType value)
VisionPrescription	setDispense(List<VisionPrescription.VisionPrescriptionDispenseComponent> theDispense)
VisionPrescription	setEncounter(Reference value)
VisionPrescription	setEncounterTarget(Encounter value)
VisionPrescription	setIdentifier(List<Identifier> theIdentifier)
VisionPrescription	setPatient(Reference value)
VisionPrescription	setPatientTarget(Patient value)
VisionPrescription	setPrescriber(Reference value)
VisionPrescription	setPrescriberTarget(Resource value)
Base	setProperty(int hash, String name, Base value)
Base	setProperty(String name, Base value)
VisionPrescription	setReason(Type value)
VisionPrescription	setStatus(VisionPrescription.VisionStatus value)
VisionPrescription	setStatusElement(Enumeration<VisionPrescription.VisionStatus> value)
protected VisionPrescription	typedCopy()

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, castToExtension, castToHumanName, castToId, castToIdentifier, castToInstant, castToInteger, castToMarkdown, castToMarketingStatus, castToMeta, castToMoney, castToNarrative, castToOid, castToParameterDefinition, castToPeriod, 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, 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

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

getMeta, getStructureFhirVersionEnum, setId

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

getFormatCommentsPost, getFormatCommentsPre, hasFormatComment

Field Detail

identifier

protected List<Identifier> identifier

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

status

protected Enumeration<VisionPrescription.VisionStatus> status

The status of the resource instance.

patient

protected Reference patient

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

patientTarget

protected Patient patientTarget

The actual object that is the target of the reference (A link to a resource representing the person to whom the vision products will be supplied.)

encounter

protected Reference encounter

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

encounterTarget

protected Encounter encounterTarget

The actual object that is the target of the reference (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)

dateWritten

protected DateTimeType dateWritten

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

prescriber

protected Reference prescriber

The healthcare professional responsible for authorizing the prescription.

prescriberTarget

protected Resource prescriberTarget

The actual object that is the target of the reference (The healthcare professional responsible for authorizing the prescription.)

reason

protected Type reason

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

dispense

protected List<VisionPrescription.VisionPrescriptionDispenseComponent> dispense

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

SP_PRESCRIBER

public static final String SP_PRESCRIBER

Search parameter: prescriber

Description: Who authorizes the vision product
Type: reference
Path: VisionPrescription.prescriber

See Also:

Constant Field Values

PRESCRIBER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRESCRIBER

Fluent Client search parameter constant for prescriber

Description: Who authorizes the vision product
Type: reference
Path: VisionPrescription.prescriber

INCLUDE_PRESCRIBER

public static final ca.uhn.fhir.model.api.Include INCLUDE_PRESCRIBER

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

SP_IDENTIFIER

public static final String SP_IDENTIFIER

Search parameter: identifier

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

See Also:

Constant Field Values

IDENTIFIER

public static final ca.uhn.fhir.rest.gclient.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: 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 ca.uhn.fhir.rest.gclient.ReferenceClientParam PATIENT

Fluent Client search parameter constant for patient

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

INCLUDE_PATIENT

public static final ca.uhn.fhir.model.api.Include INCLUDE_PATIENT

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

SP_DATEWRITTEN

public static final String SP_DATEWRITTEN

Search parameter: datewritten

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

See Also:

Constant Field Values

DATEWRITTEN

public static final ca.uhn.fhir.rest.gclient.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: encounter

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

See Also:

Constant Field Values

ENCOUNTER

public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam ENCOUNTER

Fluent Client search parameter constant for encounter

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

INCLUDE_ENCOUNTER

public static final ca.uhn.fhir.model.api.Include INCLUDE_ENCOUNTER

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

SP_STATUS

public static final String SP_STATUS

Search parameter: status

Description: The status of the vision prescription
Type: token
Path: VisionPrescription.status

See Also:

Constant Field Values

STATUS

public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS

Fluent Client search parameter constant for status

Description: The status of the vision prescription
Type: token
Path: VisionPrescription.status

Constructor Detail

VisionPrescription

public VisionPrescription()

Constructor

Method Detail

getIdentifier

public List<Identifier> getIdentifier()

Returns:

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

setIdentifier

public VisionPrescription setIdentifier(List<Identifier> theIdentifier)

Returns:

Returns a reference to this for easy method chaining

hasIdentifier

public boolean hasIdentifier()

addIdentifier

public Identifier addIdentifier()

addIdentifier

public VisionPrescription addIdentifier(Identifier t)

getIdentifierFirstRep

public Identifier getIdentifierFirstRep()

Returns:

The first repetition of repeating field identifier, creating it if it does not already exist

getStatusElement

public Enumeration<VisionPrescription.VisionStatus> getStatusElement()

Returns:

status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

hasStatusElement

public boolean hasStatusElement()

hasStatus

public boolean hasStatus()

setStatusElement

public VisionPrescription setStatusElement(Enumeration<VisionPrescription.VisionStatus> value)

Parameters:

value - status (The status of the resource instance.). This is the underlying object with id, value and extensions. The accessor "getStatus" gives direct access to the value

getStatus

public VisionPrescription.VisionStatus getStatus()

Returns:

The status of the resource instance.

setStatus

public VisionPrescription setStatus(VisionPrescription.VisionStatus value)

Parameters:

value - The status of the resource instance.

getPatient

public Reference getPatient()

Returns:

patient (A link to a resource representing the person to whom the vision products will be supplied.)

hasPatient

public boolean hasPatient()

setPatient

public VisionPrescription setPatient(Reference value)

Parameters:

value - patient (A link to a resource representing the person to whom the vision products will be supplied.)

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. (A link to a resource representing the person to whom the vision products will be supplied.)

setPatientTarget

public VisionPrescription 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. (A link to a resource representing the person to whom the vision products will be supplied.)

getEncounter

public Reference getEncounter()

Returns:

encounter (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)

hasEncounter

public boolean hasEncounter()

setEncounter

public VisionPrescription setEncounter(Reference value)

Parameters:

value - encounter (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)

getEncounterTarget

public Encounter getEncounterTarget()

Returns:

encounter 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. (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)

setEncounterTarget

public VisionPrescription setEncounterTarget(Encounter value)

Parameters:

value - encounter 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. (A link to a resource that identifies the particular occurrence of contact between patient and health care provider.)

getDateWrittenElement

public DateTimeType getDateWrittenElement()

Returns:

dateWritten (The date (and perhaps time) when the prescription was written.). This is the underlying object with id, value and extensions. The accessor "getDateWritten" gives direct access to the value

hasDateWrittenElement

public boolean hasDateWrittenElement()

hasDateWritten

public boolean hasDateWritten()

setDateWrittenElement

public VisionPrescription setDateWrittenElement(DateTimeType value)

Parameters:

value - dateWritten (The date (and perhaps time) when the prescription was written.). This is the underlying object with id, value and extensions. The accessor "getDateWritten" gives direct access to the value

getDateWritten

public Date getDateWritten()

Returns:

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

setDateWritten

public VisionPrescription setDateWritten(Date value)

Parameters:

value - The date (and perhaps time) when the prescription was written.

getPrescriber

public Reference getPrescriber()

Returns:

prescriber (The healthcare professional responsible for authorizing the prescription.)

hasPrescriber

public boolean hasPrescriber()

setPrescriber

public VisionPrescription setPrescriber(Reference value)

Parameters:

value - prescriber (The healthcare professional responsible for authorizing the prescription.)

getPrescriberTarget

public Resource getPrescriberTarget()

Returns:

prescriber 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 healthcare professional responsible for authorizing the prescription.)

setPrescriberTarget

public VisionPrescription setPrescriberTarget(Resource value)

Parameters:

value - prescriber 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 healthcare professional responsible for authorizing the prescription.)

getReason

public Type getReason()

Returns:

reason (Can be the reason or the indication for writing the prescription.)

getReasonCodeableConcept

public CodeableConcept getReasonCodeableConcept()
                                         throws org.hl7.fhir.exceptions.FHIRException

Returns:

reason (Can be the reason or the indication for writing the prescription.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasReasonCodeableConcept

public boolean hasReasonCodeableConcept()

getReasonReference

public Reference getReasonReference()
                             throws org.hl7.fhir.exceptions.FHIRException

Returns:

reason (Can be the reason or the indication for writing the prescription.)

Throws:

org.hl7.fhir.exceptions.FHIRException

hasReasonReference

public boolean hasReasonReference()

hasReason

public boolean hasReason()

setReason

public VisionPrescription setReason(Type value)

Parameters:

value - reason (Can be the reason or the indication for writing the prescription.)

getDispense

public List<VisionPrescription.VisionPrescriptionDispenseComponent> getDispense()

Returns:

dispense (Deals with details of the dispense part of the supply specification.)

setDispense

public VisionPrescription setDispense(List<VisionPrescription.VisionPrescriptionDispenseComponent> theDispense)

Returns:

Returns a reference to this for easy method chaining

hasDispense

public boolean hasDispense()

addDispense

public VisionPrescription.VisionPrescriptionDispenseComponent addDispense()

addDispense

public VisionPrescription addDispense(VisionPrescription.VisionPrescriptionDispenseComponent t)

getDispenseFirstRep

public VisionPrescription.VisionPrescriptionDispenseComponent getDispenseFirstRep()

Returns:

The first repetition of repeating field dispense, creating it if it does not already exist

listChildren

protected void listChildren(List<Property> children)

Overrides:

listChildren in class DomainResource

getNamedProperty

public Property getNamedProperty(int _hash,
                                 String _name,
                                 boolean _checkValid)
                          throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getNamedProperty in class DomainResource

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 class DomainResource

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 class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

setProperty

public Base setProperty(String name,
                        Base value)
                 throws org.hl7.fhir.exceptions.FHIRException

Overrides:

setProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

makeProperty

public Base makeProperty(int hash,
                         String name)
                  throws org.hl7.fhir.exceptions.FHIRException

Overrides:

makeProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

getTypesForProperty

public String[] getTypesForProperty(int hash,
                                    String name)
                             throws org.hl7.fhir.exceptions.FHIRException

Overrides:

getTypesForProperty in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

addChild

public Base addChild(String name)
              throws org.hl7.fhir.exceptions.FHIRException

Overrides:

addChild in class DomainResource

Throws:

org.hl7.fhir.exceptions.FHIRException

fhirType

public String fhirType()

Overrides:

fhirType in class DomainResource

copy

public VisionPrescription copy()

Specified by:

copy in class DomainResource

typedCopy

protected VisionPrescription typedCopy()

equalsDeep

public boolean equalsDeep(Base other_)

Overrides:

equalsDeep in class DomainResource

equalsShallow

public boolean equalsShallow(Base other_)

Overrides:

equalsShallow in class DomainResource

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface org.hl7.fhir.instance.model.api.IBase

Overrides:

isEmpty in class DomainResource

getResourceType

public ResourceType getResourceType()

Specified by:

getResourceType in class Resource