Class VisionPrescription

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IResource, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseResource

    public class VisionPrescription
    extends BaseResource
    implements ca.uhn.fhir.model.api.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
    • 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 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 constant for 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

      • 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 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 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 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

      • PRESCRIBER

        public static final ca.uhn.fhir.rest.gclient.ReferenceClientParam PRESCRIBER
        Fluent Client search parameter constant for prescriber

        Description:
        Type: reference
        Path: VisionPrescription.prescriber

      • 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".
      • 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".
      • 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".
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
      • getAllPopulatedChildElementsOfType

        public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
        Specified by:
        getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
      • getIdentifier

        public List<IdentifierDtgetIdentifier()
        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 ca.uhn.fhir.model.primitive.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. This method may return null.

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

      • setDateWritten

        public VisionPrescription setDateWritten​(ca.uhn.fhir.model.primitive.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,
                                                 ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
        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.

      • 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

      • 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 ca.uhn.fhir.model.api.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​(ca.uhn.fhir.model.api.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.DispensegetDispense()
        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.

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

      • 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 ca.uhn.fhir.model.api.IResource
      • getStructureFhirVersionEnum

        public ca.uhn.fhir.context.FhirVersionEnum getStructureFhirVersionEnum()
        Specified by:
        getStructureFhirVersionEnum in interface org.hl7.fhir.instance.model.api.IBaseResource
        Specified by:
        getStructureFhirVersionEnum in interface ca.uhn.fhir.model.api.IResource