ObservationDefinition class

ObservationDefinition Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

Mixed in types

• Resource

Annotations

• @freezed

Constructors

ObservationDefinition({@Default(R5ResourceType.ObservationDefinition) @JsonKey(unknownEnumValue: R5ResourceType.ObservationDefinition) R5ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') FhirId? fhirId, FhirMeta? meta, FhirUri? implicitRules, @JsonKey(name: '_implicitRules') Element? implicitRulesElement, FhirCode? language, @JsonKey(name: '_language') Element? languageElement, Narrative? text, List<Resource>? contained, @JsonKey(name: 'extension') List<FhirExtension>? extension_, List<FhirExtension>? modifierExtension, FhirUri? url, @JsonKey(name: '_url') Element? urlElement, Identifier? identifier, String? version, @JsonKey(name: '_version') Element? versionElement, String? versionAlgorithmString, @JsonKey(name: '_versionAlgorithmString') Element? versionAlgorithmStringElement, Coding? versionAlgorithmCoding, String? name, @JsonKey(name: '_name') Element? nameElement, String? title, @JsonKey(name: '_title') Element? titleElement, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, FhirBoolean? experimental, @JsonKey(name: '_experimental') Element? experimentalElement, FhirDateTime? date, @JsonKey(name: '_date') Element? dateElement, String? publisher, @JsonKey(name: '_publisher') Element? publisherElement, List<ContactDetail>? contact, FhirMarkdown? description, @JsonKey(name: '_description') Element? descriptionElement, List<UsageContext>? useContext, List<CodeableConcept>? jurisdiction, FhirMarkdown? purpose, @JsonKey(name: '_purpose') Element? purposeElement, FhirMarkdown? copyright, @JsonKey(name: '_copyright') Element? copyrightElement, String? copyrightLabel, @JsonKey(name: '_copyrightLabel') Element? copyrightLabelElement, FhirDate? approvalDate, @JsonKey(name: '_approvalDate') Element? approvalDateElement, FhirDate? lastReviewDate, @JsonKey(name: '_lastReviewDate') Element? lastReviewDateElement, Period? effectivePeriod, List<CodeableConcept>? topic, List<ContactDetail>? author, List<ContactDetail>? editor, List<ContactDetail>? reviewer, List<ContactDetail>? endorser, List<RelatedArtifact>? relatedArtifact, List<FhirCanonical>? derivedFromCanonical, List<FhirUri>? derivedFromUri, @JsonKey(name: '_derivedFromUri') List<Element>? derivedFromUriElement, List<CodeableConcept>? subject, CodeableConcept? performerType, List<CodeableConcept>? category, required CodeableConcept code, List<FhirCode>? permittedDataType, @JsonKey(name: '_permittedDataType') List<Element>? permittedDataTypeElement, FhirBoolean? multipleResultsAllowed, @JsonKey(name: '_multipleResultsAllowed') Element? multipleResultsAllowedElement, CodeableConcept? bodySite, CodeableConcept? method, List<Reference>? specimen, List<Reference>? device, String? preferredReportName, @JsonKey(name: '_preferredReportName') Element? preferredReportNameElement, List<Coding>? permittedUnit, List<ObservationDefinitionQualifiedValue>? qualifiedValue, List<Reference>? hasMember, List<ObservationDefinitionComponent>? component})

ObservationDefinition Set of definitional characteristics for a kind of observation or measurement produced or consumed by an orderable health care service.

const

factory

ObservationDefinition.fromJson(Map<String, dynamic> json)

Factory constructor, accepts Map<String, dynamic> as an argument

factory

ObservationDefinition.fromJsonString(String source)

Acts like a constructor, returns a ObservationDefinition, accepts a String as an argument, mostly because I got tired of typing it out

factory

ObservationDefinition.fromYaml(dynamic yaml)

Factory constructor that accepts a String in YAML format as an argument

factory

Properties

approvalDate → FhirDate?

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

no setter, inherited

approvalDateElement → Element?

approvalDateElement ("_approvalDate") Extensions for approvalDate

no setter, inherited

author → List<ContactDetail>?

author An individiual or organization primarily involved in the creation and maintenance of the {{title}}.

no setter, inherited

bodySite → CodeableConcept?

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

no setter, inherited

category → List<CodeableConcept>?

category A code that classifies the general type of observation.

no setter, inherited

code → CodeableConcept

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

no setter, inherited

component → List<ObservationDefinitionComponent>?

component Some observations have multiple component observations, expressed as separate code value pairs.

no setter, inherited

contact → List<ContactDetail>?

contact Contact details to assist a user in finding and communicating with the publisher.

no setter, inherited

contained → List<Resource>?

contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

no setter, inherited

copyright → FhirMarkdown?

copyright Copyright statement relating to the ObservationDefinition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the ObservationDefinition.

no setter, inherited

copyrightElement → Element?

copyrightElement ("_copyright") Extensions for copyright

no setter, inherited

copyrightLabel → String?

copyrightLabel A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

no setter, inherited

copyrightLabelElement → Element?

copyrightLabelElement ("_copyrightLabel") Extensions for copyrightLabel

no setter, inherited

copyWith → $ObservationDefinitionCopyWith<ObservationDefinition>

no setter, inherited

date → FhirDateTime?

date The date (and optionally time) when the ObservationDefinition was last significantly changed. 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.

no setter, inherited

dateElement → Element?

dateElement ("_date") Extensions for date

no setter, inherited

dbId → int?

no setter, inherited

derivedFromCanonical → List<FhirCanonical>?

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

no setter, inherited

derivedFromUri → List<FhirUri>?

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.

no setter, inherited

derivedFromUriElement → List<Element>?

derivedFromUriElement ("_derivedFromUri") Extensions for derivedFromUri

no setter, inherited

description → FhirMarkdown?

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

no setter, inherited

descriptionElement → Element?

descriptionElement ("_description") Extensions for description

no setter, inherited

device → List<Reference>?

device The measurement model of device or actual device used to produce observations of this type.

no setter, inherited

editor → List<ContactDetail>?

editor An individual or organization primarily responsible for internal coherence of the {{title}}.

no setter, inherited

effectivePeriod → Period?

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

no setter, inherited

endorser → List<ContactDetail>?

endorser An individual or organization asserted by the publisher to be responsible for officially endorsing the {{title}} for use in some setting.

no setter, inherited

experimental → FhirBoolean?

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.

no setter, inherited

experimentalElement → Element?

experimentalElement ("_experimental") Extensions for experimental

no setter, inherited

extension_ → List<FhirExtension>?

extension_ ("extension") May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

no setter, inherited

fhirId → FhirId?

id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasMember → 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.

no setter, inherited

identifier → 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.

no setter, inherited

implicitRules → FhirUri?

implicitRules A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

no setter, inherited

implicitRulesElement → Element?

implicitRulesElement ("_implicitRules") Extensions for implicitRules

no setter, inherited

jurisdiction → List<CodeableConcept>?

jurisdiction A jurisdiction in which the ObservationDefinition is intended to be used.

no setter, inherited

language → FhirCode?

language The base language in which the resource is written.

no setter, inherited

languageElement → Element?

languageElement ("_language") Extensions for language

no setter, inherited

lastReviewDate → FhirDate?

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

no setter, inherited

lastReviewDateElement → Element?

lastReviewDateElement ("_lastReviewDate") Extensions for lastReviewDate

no setter, inherited

meta → FhirMeta?

meta The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

no setter, inherited

method → CodeableConcept?

method The method or technique used to perform the observation.

no setter, inherited

modifierExtension → List<FhirExtension>?

modifierExtension May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

no setter, inherited

multipleResultsAllowed → FhirBoolean?

multipleResultsAllowed Multiple results allowed for observations conforming to this ObservationDefinition.

no setter, inherited

multipleResultsAllowedElement → Element?

multipleResultsAllowedElement ("_multipleResultsAllowed") Extensions for multipleResultsAllowed

no setter, inherited

name → String?

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.

no setter, inherited

nameElement → Element?

nameElement ("_name") Extensions for name

no setter, inherited

path → String

Local Reference for this Resource, form is "ResourceType/Id"

no setter, inherited

performerType → CodeableConcept?

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

no setter, inherited

permittedDataType → List<FhirCode>?

permittedDataType The data types allowed for the value element of the instance observations conforming to this ObservationDefinition.

no setter, inherited

permittedDataTypeElement → List<Element>?

permittedDataTypeElement ("_permittedDataType") Extensions for permittedDataType

no setter, inherited

permittedUnit → List<Coding>?

permittedUnit Units allowed for the valueQuantity element in the instance observations conforming to this ObservationDefinition.

no setter, inherited

preferredReportName → String?

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

no setter, inherited

preferredReportNameElement → Element?

preferredReportNameElement ("_preferredReportName") Extensions for preferredReportName

no setter, inherited

publisher → String?

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

no setter, inherited

publisherElement → Element?

publisherElement ("_publisher") Extensions for publisher

no setter, inherited

purpose → FhirMarkdown?

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

no setter, inherited

purposeElement → Element?

purposeElement ("_purpose") Extensions for purpose

no setter, inherited

qualifiedValue → List<ObservationDefinitionQualifiedValue>?

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.

no setter, inherited

relatedArtifact → List<RelatedArtifact>?

relatedArtifact Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

no setter, inherited

resourceType → R5ResourceType

resourceType This is a ObservationDefinition resource

no setter, inherited

resourceTypeString → String?

produce a string of the resourceType

no setter, inherited

reviewer → List<ContactDetail>?

reviewer An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the {{title}}.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

specimen → List<Reference>?

specimen The kind of specimen that this type of observation is produced on.

no setter, inherited

status → FhirCode?

status The current state of the ObservationDefinition.

no setter, inherited

statusElement → Element?

statusElement ("_status") Extensions for status

no setter, inherited

subject → List<CodeableConcept>?

subject A code that describes the intended kind of subject of Observation instances conforming to this ObservationDefinition.

no setter, inherited

text → Narrative?

text A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

no setter, inherited

thisReference → Reference

Convenience method to return a Reference referring to that Resource

no setter, inherited

title → String?

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

no setter, inherited

titleElement → Element?

titleElement ("_title") Extensions for title

no setter, inherited

topic → List<CodeableConcept>?

topic Descriptive topics related to the content of the {{title}}. Topics provide a high-level categorization as well as keywords for the {{title}} that can be useful for filtering and searching.

no setter, inherited

url → FhirUri?

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.

no setter, inherited

urlElement → Element?

urlElement ("_url") Extensions for url

no setter, inherited

useContext → 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.

no setter, inherited

version → String?

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.

no setter, inherited

versionAlgorithmCoding → Coding?

versionAlgorithmCoding Indicates the mechanism used to compare versions to determine which is more current.

no setter, inherited

versionAlgorithmString → String?

versionAlgorithmString Indicates the mechanism used to compare versions to determine which is more current.

no setter, inherited

versionAlgorithmStringElement → Element?

versionAlgorithmStringElement ("_versionAlgorithmString") Extensions for versionAlgorithmString

no setter, inherited

versionElement → Element?

versionElement ("_version") Extensions for version

no setter, inherited

Methods

newId() → Resource

returns the same resource with a new ID (even if there is already an ID present)

inherited

newIdIfNoId() → Resource

returns the same resource with a new ID if there is no current ID

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toDbJson() → Map<String, dynamic>

The normal toJson ignores the dbId, and produces the fhirId as the id However, if you're going to use this as a database entry, you have to switch those two ids

inherited

toJson() → Map<String, dynamic>

inherited

toJsonString() → String

Another convenience method because more and more I'm transmitting FHIR data as a String and not a Map

override

toString() → String

A string representation of this object.

inherited

toYaml() → String

Produces a Yaml formatted String version of the object

override

updateVersion({FhirMeta? oldMeta}) → Resource

Updates the meta field of this Resource, updates the meta.lastUpdated field, adds 1 to the version number

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited