Specimen class

Specimen A sample to be used for analysis.

Mixed in types
Annotations
  • @freezed

Constructors

Specimen({@Default(R4ResourceType.Specimen) @JsonKey(unknownEnumValue: R4ResourceType.Specimen) R4ResourceType resourceType, @JsonKey(includeFromJson: true, includeToJson: false) int? dbId, @JsonKey(name: 'id') String? 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, List<Identifier>? identifier, Identifier? accessionIdentifier, FhirCode? status, @JsonKey(name: '_status') Element? statusElement, CodeableConcept? type, Reference? subject, FhirDateTime? receivedTime, @JsonKey(name: '_receivedTime') Element? receivedTimeElement, List<Reference>? parent, List<Reference>? request, SpecimenCollection? collection, List<SpecimenProcessing>? processing, List<SpecimenContainer>? container, List<CodeableConcept>? condition, List<Annotation>? note})
Specimen A sample to be used for analysis.
const
factory
Specimen.fromJson(Map<String, dynamic> json)
Factory constructor, accepts Map<String, dynamic> as an argument
factory
Specimen.fromJsonString(String source)
Acts like a constructor, returns a Specimen, accepts a String as an argument, mostly because I got tired of typing it out
factory
Specimen.fromYaml(dynamic yaml)
Factory constructor that accepts a String in YAML format as an argument
factory

Properties

accessionIdentifier Identifier?
accessionIdentifier The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures.
no setterinherited
collection SpecimenCollection?
collection Details concerning the specimen collection.
no setterinherited
condition List<CodeableConcept>?
condition A mode or state of being that describes the nature of the specimen.
no setterinherited
contained List<Resource>?
contained These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
no setterinherited
container List<SpecimenContainer>?
container The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.
no setterinherited
copyWith → $SpecimenCopyWith<Specimen>
no setterinherited
dbId int?
no setterinherited
extension_ List<FhirExtension>?
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 manageable, 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 setterinherited
fhirId String?
id The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
identifier List<Identifier>?
identifier Id for specimen.
no setterinherited
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 setterinherited
implicitRulesElement Element?
implicitRulesElement Extensions for implicitRules
no setterinherited
language FhirCode?
language The base language in which the resource is written.
no setterinherited
languageElement Element?
languageElement Extensions for language
no setterinherited
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 setterinherited
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 manageable, 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 setterinherited
note List<Annotation>?
note To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).
no setterinherited
parent List<Reference>?
parent Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.
no setterinherited
path String
Local Reference for this Resource, form is "ResourceType/Id"
no setterinherited
processing List<SpecimenProcessing>?
processing Details concerning processing and processing steps for the specimen.
no setterinherited
receivedTime FhirDateTime?
receivedTime Time when specimen was received for processing or testing.
no setterinherited
receivedTimeElement Element?
receivedTimeElement Extensions for receivedTime
no setterinherited
request List<Reference>?
request Details concerning a service request that required a specimen to be collected.
no setterinherited
resourceType R4ResourceType
no setterinherited
resourceTypeString String?
produce a string of the resourceType
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
status FhirCode?
status The availability of the specimen.
no setterinherited
statusElement Element?
statusElement Extensions for status
no setterinherited
subject Reference?
subject Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.
no setterinherited
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 setterinherited
thisReference Reference
Convenience method to return a Reference referring to that Resource
no setterinherited
type CodeableConcept?
type The kind of material that forms the specimen.
no setterinherited

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