Private OptionalidentifierImmunizationEvaluation.identifier Element
Private ReadonlymedicationFHIR CodeSystem: MedicationAdminStatus
PrivatestatusImmunizationEvaluation.status Element
FHIR Specification
codeCodeSystem Enumeration: MedicationAdminStatusEnum
PrivatepatientImmunizationEvaluation.patient Element
FHIR Specification
Reference
Private OptionaldateImmunizationEvaluation.date Element
Private OptionalauthorityImmunizationEvaluation.authority Element
FHIR Specification
Reference
PrivatetargetImmunizationEvaluation.targetDisease Element
PrivateimmunizationImmunizationEvaluation.immunizationEvent Element
FHIR Specification
Reference
PrivatedoseImmunizationEvaluation.doseStatus Element
Private OptionaldoseImmunizationEvaluation.doseStatusReason Element
Private OptionaldescriptionImmunizationEvaluation.description Element
Private OptionalseriesImmunizationEvaluation.series Element
Private OptionaldoseImmunizationEvaluation.doseNumber[x] Element
FHIR Specification
Private OptionalseriesImmunizationEvaluation.seriesDoses[x] Element
FHIR Specification
StaticparseParse the provided ImmunizationEvaluation JSON to instantiate the ImmunizationEvaluation data model.
JSON representing FHIR ImmunizationEvaluation
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ImmunizationEvaluation
ImmunizationEvaluation data model or undefined for ImmunizationEvaluation
JsonError if the provided JSON is not a valid JSON object
the identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: MedicationAdminStatusEnum
Assigns the provided EnumCodeType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: MedicationAdminStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a CodeType if defined; else null
CodeSystem Enumeration: MedicationAdminStatusEnum
Assigns the provided PrimitiveType value to the status property.
the status value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: MedicationAdminStatusEnum
true if the status property exists and has a value; false otherwise
the status property value as a fhirCode if defined; else null
CodeSystem Enumeration: MedicationAdminStatusEnum
Assigns the provided primitive value to the status property.
the status value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: MedicationAdminStatusEnum
true if the status property exists and has a value; false otherwise
the patient property value as a Reference object if defined; else an empty Reference object
Assigns the provided Patient object value to the patient property.
the patient object value
this
InvalidTypeError for invalid data type or reference value
true if the patient property exists and has a value; false otherwise
the date property value as a DateTimeType object if defined; else an empty DateTimeType object
Assigns the provided PrimitiveType value to the date property.
the date value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the date property value as a fhirDateTime if defined; else undefined
Assigns the provided primitive value to the date property.
the date value
this
PrimitiveTypeError for invalid primitive types
true if the date property exists and has a value; false otherwise
the authority property value as a Reference object; else an empty Reference object
Assigns the provided Authority object value to the authority property.
the authority object value
this
InvalidTypeError for invalid data type or reference value
true if the authority property exists and has a value; false otherwise
the targetDisease property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CodeableConcept object value to the targetDisease property.
the targetDisease object value
this
InvalidTypeError for invalid data types
true if the targetDisease property exists and has a value; false otherwise
the immunizationEvent property value as a Reference object if defined; else an empty Reference object
Assigns the provided ImmunizationEvent object value to the immunizationEvent property.
the immunizationEvent object value
this
InvalidTypeError for invalid data type or reference value
true if the immunizationEvent property exists and has a value; false otherwise
the doseStatus property value as a CodeableConcept object if defined; else an empty CodeableConcept object
Assigns the provided CodeableConcept object value to the doseStatus property.
the doseStatus object value
this
InvalidTypeError for invalid data types
true if the doseStatus property exists and has a value; false otherwise
the doseStatusReason property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the doseStatusReason property.
the doseStatusReason array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the doseStatusReason array property.
the doseStatusReason value
this
InvalidTypeError for invalid data types
true if the doseStatusReason property exists and has a value; false otherwise
the description property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the description property.
the description value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the description property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the description property.
the description value
this
PrimitiveTypeError for invalid primitive types
true if the description property exists and has a value; false otherwise
the series property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the series property.
the series value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the series property exists and has a value; false otherwise
the series property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the series property.
the series value
this
PrimitiveTypeError for invalid primitive types
true if the series property exists and has a value; false otherwise
the doseNumber property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the doseNumber property.
the doseNumber object value
this
InvalidTypeError for invalid data types
true if the doseNumber property exists and has a value; false otherwise
the doseNumber property value as a PositiveIntType object if defined; else undefined
true if the doseNumber property exists as a PositiveIntType and has a value; false otherwise
the doseNumber property value as a StringType object if defined; else undefined
true if the doseNumber property exists as a StringType and has a value; false otherwise
the seriesDoses property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the seriesDoses property.
the seriesDoses object value
this
InvalidTypeError for invalid data types
true if the seriesDoses property exists and has a value; false otherwise
the seriesDoses property value as a PositiveIntType object if defined; else undefined
true if the seriesDoses property exists as a PositiveIntType and has a value; false otherwise
the seriesDoses property value as a StringType object if defined; else undefined
true if the seriesDoses property exists as a StringType and has a value; false otherwise
the FHIR type defined in the FHIR standard
true if the instance is empty; 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
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 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 identifier property
PrivateinitInitialize the doseStatusReason property
ImmunizationEvaluation Class
Remarks
Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.
FHIR Specification
See
FHIR ImmunizationEvaluation