Package org.hl7.fhir.r5.model

Class ObservationDefinition

java.lang.Object
org.hl7.fhir.r5.model.Base
org.hl7.fhir.r5.model.BaseResource
org.hl7.fhir.r5.model.Resource
org.hl7.fhir.r5.model.DomainResource
org.hl7.fhir.r5.model.ObservationDefinition
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 ObservationDefinition extends DomainResource
Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.
See Also:

  • Field Details

    • url

      protected UriType url
      An absolute URL that is used to identify this ObservationDefinition when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this ObservationDefinition is (or will be) published. The URL SHOULD include the major version of the ObservationDefinition. For more information see Technical and Business Versions.

    • identifier

      protected Identifier identifier
      Business identifiers assigned to this ObservationDefinition. by the performer and/or other systems. These identifiers remain constant as the resource is updated and propagates from server to server.

    • version

      protected StringType version
      The identifier that is used to identify this version of the ObservationDefinition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the ObservationDefinition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions are orderable.

    • name

      protected StringType name
      A natural language name identifying the ObservationDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

    • title

      protected StringType title
      A short, descriptive, user-friendly title for the ObservationDefinition.

    • status

      protected Enumeration<Enumerations.PublicationStatus> status
      The current state of the ObservationDefinition.

    • experimental

      protected BooleanType experimental
      A flag to indicate that this ObservationDefinition is authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.

    • date

      protected DateTimeType date
      The date (and optionally time) when the ObservationDefinition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the ObservationDefinition changes.

    • publisher

      protected Reference publisher
      Helps establish the "authority/credibility" of the ObservationDefinition. May also allow for contact.

    • contact

      protected List<ContactDetail> contact
      Contact details to assist a user in finding and communicating with the publisher.

    • description

      protected MarkdownType description
      A free text natural language description of the ObservationDefinition from the consumer's perspective.

    • useContext

      protected List<UsageContext> useContext
      The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate ObservationDefinition instances.

    • jurisdiction

      protected List<CodeableConcept> jurisdiction
      A jurisdiction in which the ObservationDefinition is intended to be used.

    • purpose

      protected MarkdownType purpose
      Explains why this ObservationDefinition is needed and why it has been designed as it has.

    • approvalDate

      protected DateType approvalDate
      The date on which the asset content was approved by the publisher. Approval happens once when the content is officially approved for usage.

    • lastReviewDate

      protected DateType lastReviewDate
      The date on which the asset content was last reviewed. Review happens periodically after that, but doesn't change the original approval date.

    • effectivePeriod

      protected Period effectivePeriod
      The period during which the ObservationDefinition content was or is planned to be effective.

    • derivedFromCanonical

      protected List<CanonicalType> derivedFromCanonical
      The canonical URL pointing to another FHIR-defined ObservationDefinition that is adhered to in whole or in part by this definition.

    • derivedFromUri

      protected List<UriType> derivedFromUri
      The URL pointing to an externally-defined observation definition, guideline or other definition that is adhered to in whole or in part by this definition.

    • subject

      protected List<CodeableConcept> subject
      A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.

    • performerType

      protected CodeableConcept performerType
      The type of individual/organization/device that is expected to act upon instances of this definition.

    • category

      protected List<CodeableConcept> category
      A code that classifies the general type of observation.

    • code

      protected CodeableConcept code
      Describes what will be observed. Sometimes this is called the observation "name".

    • permittedDataType

      protected List<Enumeration<ObservationDefinition.ObservationDataType>> permittedDataType
      The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

    • multipleResultsAllowed

      protected BooleanType multipleResultsAllowed
      Multiple results allowed for observations conforming to this ObservationDefinition.

    • bodySite

      protected CodeableConcept bodySite
      The site on the subject's body where the observation is to be made.

    • method

      protected CodeableConcept method
      The method or technique used to perform the observation.

    • specimen

      protected List<Reference> specimen
      The kind of specimen that this type of observation is produced on.

    • device

      protected List<Reference> device
      The measurement model of device or actual device used to produce observations of this type.

    • preferredReportName

      protected StringType preferredReportName
      The preferred name to be used when reporting the results of observations conforming to this ObservationDefinition.

    • quantitativeDetails

      protected ObservationDefinition.ObservationDefinitionQuantitativeDetailsComponent quantitativeDetails
      Characteristics for quantitative results of observations conforming to this ObservationDefinition.

    • qualifiedValue

      protected List<ObservationDefinition.ObservationDefinitionQualifiedValueComponent> qualifiedValue
      A set of qualified values associated with a context and a set of conditions - provides a range for quantitative and ordinal observations and a collection of value sets for qualitative observations.

    • hasMember

      protected List<Reference> hasMember
      This ObservationDefinition defines a group observation (e.g. a battery, a panel of tests, a set of vital sign measurements) that includes the target as a member of the group.

    • component

      protected List<ObservationDefinition.ObservationDefinitionComponentComponent> component
      Some observations have multiple component observations, expressed as separate code value pairs.

    • SP_CATEGORY

      public static final String SP_CATEGORY
      Search parameter: category

      Description: Category (class) of observation
      Type: token
      Path: ObservationDefinition.category

      See Also:

    • CATEGORY

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CATEGORY
      Fluent Client search parameter constant for category

      Description: Category (class) of observation
      Type: token
      Path: ObservationDefinition.category

    • SP_CODE

      public static final String SP_CODE
      Search parameter: code

      Description: Observation code
      Type: token
      Path: ObservationDefinition.code

      See Also:

    • CODE

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam CODE
      Fluent Client search parameter constant for code

      Description: Observation code
      Type: token
      Path: ObservationDefinition.code

    • SP_EXPERIMENTAL

      public static final String SP_EXPERIMENTAL
      Search parameter: experimental

      Description: Not for genuine usage (true)
      Type: token
      Path: ObservationDefinition.experimental

      See Also:

    • EXPERIMENTAL

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam EXPERIMENTAL
      Fluent Client search parameter constant for experimental

      Description: Not for genuine usage (true)
      Type: token
      Path: ObservationDefinition.experimental

    • SP_IDENTIFIER

      public static final String SP_IDENTIFIER
      Search parameter: identifier

      Description: The unique identifier associated with the specimen definition
      Type: token
      Path: ObservationDefinition.identifier

      See Also:

    • IDENTIFIER

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam IDENTIFIER
      Fluent Client search parameter constant for identifier

      Description: The unique identifier associated with the specimen definition
      Type: token
      Path: ObservationDefinition.identifier

    • SP_METHOD

      public static final String SP_METHOD
      Search parameter: method

      Description: Method of observation
      Type: token
      Path: ObservationDefinition.method

      See Also:

    • METHOD

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam METHOD
      Fluent Client search parameter constant for method

      Description: Method of observation
      Type: token
      Path: ObservationDefinition.method

    • SP_STATUS

      public static final String SP_STATUS
      Search parameter: status

      Description: Publication status of the ObservationDefinition: draft, active, retired, unknown
      Type: token
      Path: ObservationDefinition.status

      See Also:

    • STATUS

      public static final ca.uhn.fhir.rest.gclient.TokenClientParam STATUS
      Fluent Client search parameter constant for status

      Description: Publication status of the ObservationDefinition: draft, active, retired, unknown
      Type: token
      Path: ObservationDefinition.status

    • SP_TITLE

      public static final String SP_TITLE
      Search parameter: title

      Description: Human-friendly name of the ObservationDefinition
      Type: string
      Path: ObservationDefinition.title

      See Also:

    • TITLE

      public static final ca.uhn.fhir.rest.gclient.StringClientParam TITLE
      Fluent Client search parameter constant for title

      Description: Human-friendly name of the ObservationDefinition
      Type: string
      Path: ObservationDefinition.title

    • SP_URL

      public static final String SP_URL
      Search parameter: url

      Description: The uri that identifies the observation definition
      Type: uri
      Path: ObservationDefinition.url

      See Also:

    • URL

      public static final ca.uhn.fhir.rest.gclient.UriClientParam URL
      Fluent Client search parameter constant for url

      Description: The uri that identifies the observation definition
      Type: uri
      Path: ObservationDefinition.url

  • Constructor Details

  • Method Details