Private OptionalcollectorSpecimen.collection.collector Element
Private OptionalcollectedSpecimen.collection.collected[x] Element
Private OptionaldurationSpecimen.collection.duration Element
Private OptionalquantitySpecimen.collection.quantity Element
Private OptionalmethodSpecimen.collection.method Element
Private OptionaldeviceSpecimen.collection.device Element
FHIR Specification
CodeableReference
Private OptionalprocedureSpecimen.collection.procedure Element
FHIR Specification
Reference
Private OptionalbodySpecimen.collection.bodySite Element
FHIR Specification
CodeableReference
Private OptionalfastingSpecimen.collection.fastingStatus[x] Element
@ChoiceDataTypesMeta('Specimen.collection.fastingStatus[x]', ['CodeableConcept','Duration',]
FHIR Specification
such asObservation.component code` = LOINC 49541-6 (Fasting status - Reported).StaticparseParse the provided SpecimenCollectionComponent JSON to instantiate the SpecimenCollectionComponent data model.
JSON representing FHIR SpecimenCollectionComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SpecimenCollectionComponent
SpecimenCollectionComponent data model or undefined for SpecimenCollectionComponent
JsonError if the provided JSON is not a valid JSON object
the collector property value as a Reference object; else an empty Reference object
Assigns the provided Collector object value to the collector property.
the collector object value
this
@ReferenceTargets('Specimen.collection.collector', ['Practitioner','PractitionerRole','Patient','RelatedPerson',])
InvalidTypeError for invalid data type or reference value
true if the collector property exists and has a value; false otherwise
the collected property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the collected property.
the collected object value
this
InvalidTypeError for invalid data types
true if the collected property exists and has a value; false otherwise
the collected property value as a DateTimeType object if defined; else undefined
true if the collected property exists as a DateTimeType and has a value; false otherwise
the collected property value as a Period object if defined; else undefined
true if the collected property exists as a Period and has a value; false otherwise
the duration property value as a Duration object if defined; else an empty Duration object
Assigns the provided Duration object value to the duration property.
the duration object value
this
InvalidTypeError for invalid data types
true if the duration property exists and has a value; false otherwise
the quantity property value as a Quantity object if defined; else an empty Quantity object
Assigns the provided Quantity object value to the quantity property.
the quantity object value
this
InvalidTypeError for invalid data types
true if the quantity property exists and has a value; false otherwise
the method property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided Method object value to the method property.
the method object value
this
InvalidTypeError for invalid data types
true if the method property exists and has a value; false otherwise
the device property value as a CodeableReference object if defined; else an empty CodeableReference object
Assigns the provided Device object value to the device property.
the device object value
this
InvalidTypeError for invalid data types
true if the device property exists and has a value; false otherwise
the procedure property value as a Reference object; else an empty Reference object
Assigns the provided Procedure object value to the procedure property.
the procedure object value
this
InvalidTypeError for invalid data type or reference value
true if the procedure property exists and has a value; false otherwise
the bodySite property value as a CodeableReference object if defined; else an empty CodeableReference object
Assigns the provided BodySite object value to the bodySite property.
the bodySite object value
this
InvalidTypeError for invalid data types
true if the bodySite property exists and has a value; false otherwise
the fastingStatus property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the fastingStatus property.
the fastingStatus object value
this
InvalidTypeError for invalid data types
true if the fastingStatus property exists and has a value; false otherwise
the fastingStatus property value as a CodeableConcept object if defined; else undefined
true if the fastingStatus property exists as a CodeableConcept and has a value; false otherwise
the fastingStatus property value as a Duration object if defined; else undefined
true if the fastingStatus property exists as a Duration and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; false otherwise
Creates a copy of the current instance.
the a new instance copied from the current instance
the JSON value or undefined if the instance is empty
the array of modifierExtension values
Assigns the provided array of Extension values to the modifierExtension property.
array of Extensions
this
Determines if the modifierExtension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the modifierExtension property exists and has any values.
AssertionError for invalid url
Returns the Extension having the provided url.
the url that identifies a specific Extension
the Extension having the provided url
AssertionError for invalid url
Adds the provided Extension to the modifierExtension property array.
the Extension value to add to the modifierExtension property array
this
Removes the Extension having the provided url from the modifierExtension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
the id property value
Assigns the provided value to the id property.
the id value
this
PrimitiveTypeError for invalid value
true if id exists and has a value; false otherwise
the array of extension values
Assigns the provided array of Extension values to the extension property.
array of Extensions
this
Determines if the extension property exists.
Optionalurl: stringthe url that identifies a specific Extension
true if an Extension has the provided url; false otherwise
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Determines if the extension property exists.
the url that identifies a specific Extension
an Extension having the provided url
If the url is provided, determines if an Extension having
the provided url exists. If the url is not provided, determines
if the extension property exists and has any values.
AssertionError for invalid url
Adds the provided Extension to the extension property array.
the Extension value to add to the extension property array
this
Removes the Extension having the provided url from the extension property array.
the url that identifies a specific Extension to remove
AssertionError for invalid url
true if and only if the data model has required fields (min cardinality > 0)
and at least one of those required fields in the instance is empty; false otherwise
true if the instance is a FHIR resource; false otherwise
true if the instance is a FHIR complex or primitive datatype; false otherwise
true if the instance is a FHIR complex datatype; false otherwise
true if the instance is a FHIR primitive datatype; false otherwise
true if the instance is a FHIR primitive boolean datatype; false otherwise
true if the instance is a FHIR primitive string-based datatype; false otherwise
true if the instance is a FHIR primitive number-based datatype; false otherwise
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
ProtectedcopyProtectedCopies the current instance's elements into the provided object.
the copied instance
SpecimenCollectionComponent Class
Remarks
FHIR Specification
See
FHIR Specimen