PrivatereferenceImplementationGuide.definition.resource.reference Element
FHIR Specification
Reference
Private ReadonlyfhirFHIR CodeSystem: FhirVersion
Private OptionalfhirImplementationGuide.definition.resource.fhirVersion Element
FHIR Specification
codeCodeSystem Enumeration: FhirVersionEnum
Private OptionalnameFHIR Specification
stringPrivate OptionaldescriptionImplementationGuide.definition.resource.description Element
FHIR Specification
markdownPrivate OptionalisImplementationGuide.definition.resource.isExample Element
Private OptionalprofileImplementationGuide.definition.resource.profile Element
FHIR Specification
canonical
Private OptionalgroupingImplementationGuide.definition.resource.groupingId Element
FHIR Specification
idStaticparseParse the provided ImplementationGuideDefinitionResourceComponent JSON to instantiate the ImplementationGuideDefinitionResourceComponent data model.
JSON representing FHIR ImplementationGuideDefinitionResourceComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ImplementationGuideDefinitionResourceComponent
ImplementationGuideDefinitionResourceComponent data model or undefined for ImplementationGuideDefinitionResourceComponent
JsonError if the provided JSON is not a valid JSON object
the reference property value as a Reference object if defined; else an empty Reference object
Assigns the provided Reference object value to the reference property.
the reference object value
this
InvalidTypeError for invalid data type or reference value
true if the reference property exists and has a value; false otherwise
the fhirVersion property value as a EnumCodeType array
CodeSystem Enumeration: FhirVersionEnum
Assigns the provided EnumCodeType array value to the fhirVersion property.
the fhirVersion array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirVersionEnum
Add the provided EnumCodeType value to the fhirVersion array property.
the fhirVersion value
this
InvalidCodeError for invalid code value
CodeSystem Enumeration: FhirVersionEnum
true if the fhirVersion property exists and has a value; false otherwise
the fhirVersion property value as a CodeType array
CodeSystem Enumeration: FhirVersionEnum
Assigns the provided PrimitiveType array value to the fhirVersion property.
the fhirVersion array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirVersionEnum
Add the provided PrimitiveType value to the fhirVersion array property.
the fhirVersion value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: FhirVersionEnum
true if the fhirVersion property exists and has a value; false otherwise
the fhirVersion property value as a fhirCode array
CodeSystem Enumeration: FhirVersionEnum
Assigns the provided primitive value array to the fhirVersion property.
the fhirVersion value array
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: FhirVersionEnum
Add the provided primitive value to the fhirVersion array property.
the fhirVersion value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: FhirVersionEnum
true if the fhirVersion property exists and has a value; false otherwise
the name property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the name property.
the name value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the name property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the name property.
the name value
this
PrimitiveTypeError for invalid primitive types
true if the name property exists and has a value; false otherwise
the description property value as a MarkdownType object if defined; else an empty MarkdownType 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 fhirMarkdown 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 isExample property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the isExample property.
the isExample value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the isExample property exists and has a value; false otherwise
the isExample property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the isExample property.
the isExample value
this
PrimitiveTypeError for invalid primitive types
true if the isExample property exists and has a value; false otherwise
the profile property value as a CanonicalType array
Assigns the provided CanonicalType array value to the profile property.
the profile array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the profile array property.
the profile value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the profile property exists and has a value; false otherwise
the profile property value as a fhirCanonical array
Assigns the provided primitive value array to the profile property.
the profile value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the profile array property.
the profile value
this
PrimitiveTypeError for invalid primitive types
true if the profile property exists and has a value; false otherwise
the groupingId property value as a IdType object if defined; else an empty IdType object
Assigns the provided PrimitiveType value to the groupingId property.
the groupingId value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the groupingId property exists and has a value; false otherwise
the groupingId property value as a fhirId if defined; else undefined
Assigns the provided primitive value to the groupingId property.
the groupingId value
this
PrimitiveTypeError for invalid primitive types
true if the groupingId property exists 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 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 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 fhirVersion property
PrivateinitInitialize the profile property
ImplementationGuideDefinitionResourceComponent Class
Remarks
FHIR Specification
See
FHIR ImplementationGuide