Private OptionalidentifierSpecimenDefinition.identifier Element
Private OptionaltypeSpecimenDefinition.typeCollected Element
Private OptionalpatientSpecimenDefinition.patientPreparation Element
Private OptionaltimeSpecimenDefinition.timeAspect Element
Private OptionalcollectionSpecimenDefinition.collection Element
Private OptionaltypeSpecimenDefinition.typeTested Element
StaticparseParse the provided SpecimenDefinition JSON to instantiate the SpecimenDefinition data model.
JSON representing FHIR SpecimenDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to SpecimenDefinition
SpecimenDefinition data model or undefined for SpecimenDefinition
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier object if defined; else an empty Identifier object
Assigns the provided Identifier object value to the identifier property.
the identifier object value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the typeCollected property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided TypeCollected object value to the typeCollected property.
the typeCollected object value
this
InvalidTypeError for invalid data types
true if the typeCollected property exists and has a value; false otherwise
the patientPreparation property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the patientPreparation property.
the patientPreparation array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the patientPreparation array property.
the patientPreparation value
this
InvalidTypeError for invalid data types
true if the patientPreparation property exists and has a value; false otherwise
the timeAspect property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the timeAspect property.
the timeAspect value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the timeAspect property exists and has a value; false otherwise
the timeAspect property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the timeAspect property.
the timeAspect value
this
PrimitiveTypeError for invalid primitive types
true if the timeAspect property exists and has a value; false otherwise
the collection property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the collection property.
the collection array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the collection array property.
the collection value
this
InvalidTypeError for invalid data types
true if the collection property exists and has a value; false otherwise
the typeTested property value as a SpecimenDefinitionTypeTestedComponent array
Assigns the provided SpecimenDefinitionTypeTestedComponent array value to the typeTested property.
the typeTested array value
this
InvalidTypeError for invalid data types
Add the provided SpecimenDefinitionTypeTestedComponent value to the typeTested array property.
the typeTested value
this
InvalidTypeError for invalid data types
true if the typeTested property exists 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 text property value as a Narrative
Assigns the provided value to the text property.
the text value
this
true if the text property exists and has a value; false otherwise
the contained property value as a Resource array
Assigns the provided Resource array value to the contained property.
the contained array value
this
Add the provided Resource value to the contained array property.
the contained value
this
true if the contained property 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
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 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
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
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 FHIR resource type as defined by the FHIR specification
the id property value as a PrimitiveType
Assigns the provided PrimitiveType value to the id property.
the id value
this
true if the id property exists and has a value; false otherwise
the id property value as a primitive value
Assigns the provided primitive value to the id property.
the id value
this
PrimitiveTypeError for invalid primitive types
true if the id property exists and has a value; false otherwise
the meta property value as a Meta
Assigns the provided value to the meta property.
the meta value
this
true if the meta property exists and has a value; false otherwise
the implicitRules property value as a PrimitiveType
Assigns the provided PrimitiveType value to the implicitRules property.
the implicitRules value
this
true if the implicitRules property exists and has a value; false otherwise
the implicitRules property value as a primitive value
Assigns the provided primitive value to the implicitRules property.
the implicitRules value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the language property value as a PrimitiveType
Assigns the provided PrimitiveType value to the language property.
the language value
this
true if the language property exists and has a value; false otherwise
the language property value as a primitive value
Assigns the provided primitive value to the language property.
the language value
this
PrimitiveTypeError for invalid primitive types
true if the language property exists and has a value; false otherwise
true if the instance is a FHIR resource; false otherwise
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 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
PrivateinitInitialize the patientPreparation property
PrivateinitInitialize the collection property
PrivateinitInitialize the typeTested property
SpecimenDefinition Class
Remarks
A kind of specimen with associated set of requirements.
FHIR Specification
See
FHIR SpecimenDefinition