Package org.hl7.fhir.dstu2.model

Class Observation

  • 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 Observation
extends DomainResource
    Measurements and simple assertions made about a patient, device or other subject.
    See Also:
    Serialized Form

    • Method Detail

      • getCategory

        public CodeableConcept getCategory()
        Returns:
        category (A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.)

      • setCategory

        public Observation setCategory​(CodeableConcept value)
        Parameters:
        value - category (A code that classifies the general type of observation being made. This is used for searching, sorting and display purposes.)

      • getCode

        public CodeableConcept getCode()
        Returns:
        code (Describes what was observed. Sometimes this is called the observation "name".)

      • hasCode

        public boolean hasCode()

      • getSubject

        public Reference getSubject()
        Returns:
        subject (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)

      • setSubject

        public Observation setSubject​(Reference value)
        Parameters:
        value - subject (The patient, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)

      • getSubjectTarget

        public Resource getSubjectTarget()
        Returns:
        subject 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, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)

      • setSubjectTarget

        public Observation setSubjectTarget​(Resource value)
        Parameters:
        value - subject 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, or group of patients, location, or device whose characteristics (direct or indirect) are described by the observation and into whose record the observation is placed. Comments: Indirect characteristics may be those of a specimen, fetus, donor, other observer (for example a relative or EMT), or any observation made about the subject.)

      • getEncounter

        public Reference getEncounter()
        Returns:
        encounter (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)

      • setEncounter

        public Observation setEncounter​(Reference value)
        Parameters:
        value - encounter (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)

      • 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. (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)

      • setEncounterTarget

        public Observation 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. (The healthcare event (e.g. a patient and healthcare provider interaction) during which this observation is made.)

      • getEffective

        public Type getEffective()
        Returns:
        effective (The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.)

      • getEffectiveDateTimeType

        public DateTimeType getEffectiveDateTimeType()
                                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        effective (The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getEffectivePeriod

        public Period getEffectivePeriod()
                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        effective (The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setEffective

        public Observation setEffective​(Type value)
        Parameters:
        value - effective (The time or time-period the observed value is asserted as being true. For biological subjects - e.g. human patients - this is usually called the "physiologically relevant time". This is usually either the time of the procedure or of specimen collection, but very often the source of the date/time is not known, only the date/time itself.)

      • getIssuedElement

        public InstantType getIssuedElement()
        Returns:
        issued (The date and time this observation was made available to providers, typically after the results have been reviewed and verified.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value

      • setIssuedElement

        public Observation setIssuedElement​(InstantType value)
        Parameters:
        value - issued (The date and time this observation was made available to providers, typically after the results have been reviewed and verified.). This is the underlying object with id, value and extensions. The accessor "getIssued" gives direct access to the value

      • getIssued

        public Date getIssued()
        Returns:
        The date and time this observation was made available to providers, typically after the results have been reviewed and verified.

      • setIssued

        public Observation setIssued​(Date value)
        Parameters:
        value - The date and time this observation was made available to providers, typically after the results have been reviewed and verified.

      • getPerformerTarget

        public List<Resource> getPerformerTarget()
        Returns:
        performer (The actual objects that are the target of the reference. The reference library doesn't populate this, but you can use this to hold the resources if you resolvethemt. Who was responsible for asserting the observed value as "true".)

      • getValue

        public Type getValue()
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)

      • getValueQuantity

        public Quantity getValueQuantity()
                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValueCodeableConcept

        public CodeableConcept getValueCodeableConcept()
                                        throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValueStringType

        public StringType getValueStringType()
                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValueRange

        public Range getValueRange()
                    throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValueRatio

        public Ratio getValueRatio()
                    throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValueSampledData

        public SampledData getValueSampledData()
                                throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValueAttachment

        public Attachment getValueAttachment()
                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValueTimeType

        public TimeType getValueTimeType()
                          throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValueDateTimeType

        public DateTimeType getValueDateTimeType()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • getValuePeriod

        public Period getValuePeriod()
                      throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        value (The information determined as a result of making the observation, if the information has a simple value.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException

      • setValue

        public Observation setValue​(Type value)
        Parameters:
        value - value (The information determined as a result of making the observation, if the information has a simple value.)

      • getInterpretation

        public CodeableConcept getInterpretation()
        Returns:
        interpretation (The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.)

      • setInterpretation

        public Observation setInterpretation​(CodeableConcept value)
        Parameters:
        value - interpretation (The assessment made based on the result of the observation. Intended as a simple compact code often placed adjacent to the result value in reports and flow sheets to signal the meaning/normalcy status of the result. Otherwise known as abnormal flag.)

      • getCommentsElement

        public StringType getCommentsElement()
        Returns:
        comments (May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.). This is the underlying object with id, value and extensions. The accessor "getComments" gives direct access to the value

      • setCommentsElement

        public Observation setCommentsElement​(StringType value)
        Parameters:
        value - comments (May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.). This is the underlying object with id, value and extensions. The accessor "getComments" gives direct access to the value

      • getComments

        public String getComments()
        Returns:
        May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.

      • setComments

        public Observation setComments​(String value)
        Parameters:
        value - May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result.

      • getSpecimenTarget

        public Specimen getSpecimenTarget()
        Returns:
        specimen 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 specimen that was used when this observation was made.)

      • setSpecimenTarget

        public Observation setSpecimenTarget​(Specimen value)
        Parameters:
        value - specimen 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 specimen that was used when this observation was made.)

      • getDeviceTarget

        public Resource getDeviceTarget()
        Returns:
        device 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 device used to generate the observation data.)

      • setDeviceTarget

        public Observation setDeviceTarget​(Resource value)
        Parameters:
        value - device 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 device used to generate the observation data.)

      • getComponent

        public List<Observation.ObservationComponentComponent> getComponent()
        Returns:
        component (Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.)

      • addComponent

        public Observation.ObservationComponentComponent addComponent()
        Returns:
        component (Some observations have multiple component observations. These component observations are expressed as separate code value pairs that share the same attributes. Examples include systolic and diastolic component observations for blood pressure measurement and multiple component observations for genetics observations.)

      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class DomainResource