PrivateurlStructureDefinition.url Element
FHIR Specification
uriPrivate OptionalidentifierStructureDefinition.identifier Element
FHIR Specification
IdentifierPrivate OptionalversionStructureDefinition.version Element
FHIR Specification
stringPrivatenameStructureDefinition.name Element
FHIR Specification
stringPrivate OptionaltitleStructureDefinition.title Element
FHIR Specification
stringPrivate ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusStructureDefinition.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalexperimentalStructureDefinition.experimental Element
FHIR Specification
booleanPrivate OptionaldateStructureDefinition.date Element
FHIR Specification
dateTimePrivate OptionalpublisherStructureDefinition.publisher Element
FHIR Specification
stringPrivate OptionalcontactStructureDefinition.contact Element
FHIR Specification
ContactDetailPrivate OptionaldescriptionStructureDefinition.description Element
FHIR Specification
markdownPrivate OptionaluseStructureDefinition.useContext Element
FHIR Specification
UsageContextPrivate OptionaljurisdictionStructureDefinition.jurisdiction Element
FHIR Specification
CodeableConceptPrivate OptionalpurposeStructureDefinition.purpose Element
FHIR Specification
markdownPrivate OptionalcopyrightStructureDefinition.copyright Element
FHIR Specification
markdownPrivate OptionalkeywordStructureDefinition.keyword Element
FHIR Specification
CodingPrivate ReadonlyfhirFHIR CodeSystem: FhirVersion
Private OptionalfhirStructureDefinition.fhirVersion Element
FHIR Specification
codeCodeSystem Enumeration: FhirVersionEnum
Private OptionalmappingStructureDefinition.mapping Element
Private ReadonlystructureFHIR CodeSystem: StructureDefinitionKind
PrivatekindStructureDefinition.kind Element
FHIR Specification
codeCodeSystem Enumeration: StructureDefinitionKindEnum
Privateabstract_StructureDefinition.abstract Element
FHIR Specification
booleanPrivate OptionalcontextStructureDefinition.context Element
Private OptionalcontextStructureDefinition.contextInvariant Element
FHIR Specification
stringPrivatetype_StructureDefinition.type Element
FHIR Specification
uriPrivate OptionalbaseStructureDefinition.baseDefinition Element
FHIR Specification
canonical
Private ReadonlytypeFHIR CodeSystem: TypeDerivationRule
Private OptionalderivationStructureDefinition.derivation Element
FHIR Specification
codeCodeSystem Enumeration: TypeDerivationRuleEnum
Private OptionalsnapshotStructureDefinition.snapshot Element
Private OptionaldifferentialStructureDefinition.differential Element
StaticparseParse the provided StructureDefinition JSON to instantiate the StructureDefinition data model.
JSON representing FHIR StructureDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to StructureDefinition
StructureDefinition data model or undefined for StructureDefinition
JsonError if the provided JSON is not a valid JSON object
the url property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the url property.
the url value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
the url property value as a fhirUri if defined; else null
Assigns the provided primitive value to the url property.
the url value
this
PrimitiveTypeError for invalid primitive types
true if the url property exists and has a value; false otherwise
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 version property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the version property.
the version value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the version property exists and has a value; false otherwise
the version property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the version property.
the version value
this
PrimitiveTypeError for invalid primitive types
true if the version 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 null
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 title property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the title property.
the title value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the title property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the title property.
the title value
this
PrimitiveTypeError for invalid primitive types
true if the title property exists and has a value; false otherwise
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: PublicationStatusEnum
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: PublicationStatusEnum
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: PublicationStatusEnum
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: PublicationStatusEnum
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: PublicationStatusEnum
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: PublicationStatusEnum
true if the status property exists and has a value; false otherwise
the experimental property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the experimental property.
the experimental value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the experimental property exists and has a value; false otherwise
the experimental property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the experimental property.
the experimental value
this
PrimitiveTypeError for invalid primitive types
true if the experimental 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 publisher property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the publisher property.
the publisher value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the publisher property exists and has a value; false otherwise
the publisher property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the publisher property.
the publisher value
this
PrimitiveTypeError for invalid primitive types
true if the publisher property exists and has a value; false otherwise
the contact property value as a ContactDetail array
Assigns the provided ContactDetail array value to the contact property.
the contact array value
this
InvalidTypeError for invalid data types
Add the provided ContactDetail value to the contact array property.
the contact value
this
InvalidTypeError for invalid data types
true if the contact 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 useContext property value as a UsageContext array
Assigns the provided UsageContext array value to the useContext property.
the useContext array value
this
InvalidTypeError for invalid data types
Add the provided UsageContext value to the useContext array property.
the useContext value
this
InvalidTypeError for invalid data types
true if the useContext property exists and has a value; false otherwise
the jurisdiction property value as a CodeableConcept array
Assigns the provided CodeableConcept array value to the jurisdiction property.
the jurisdiction array value
this
InvalidTypeError for invalid data types
Add the provided CodeableConcept value to the jurisdiction array property.
the jurisdiction value
this
InvalidTypeError for invalid data types
true if the jurisdiction property exists and has a value; false otherwise
the purpose property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the purpose property.
the purpose value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the purpose property exists and has a value; false otherwise
the purpose property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the purpose property.
the purpose value
this
PrimitiveTypeError for invalid primitive types
true if the purpose property exists and has a value; false otherwise
the copyright property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the copyright property.
the copyright value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the copyright property exists and has a value; false otherwise
the copyright property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the copyright property.
the copyright value
this
PrimitiveTypeError for invalid primitive types
true if the copyright property exists and has a value; false otherwise
the keyword property value as a Coding array
Assigns the provided Coding array value to the keyword property.
the keyword array value
this
InvalidTypeError for invalid data types
Add the provided Coding value to the keyword array property.
the keyword value
this
InvalidTypeError for invalid data types
true if the keyword property exists and has a value; false otherwise
the fhirVersion property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: FhirVersionEnum
Assigns the provided EnumCodeType value to the fhirVersion property.
the fhirVersion value
this
InvalidCodeError for invalid code values
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 CodeType if defined; else undefined
CodeSystem Enumeration: FhirVersionEnum
Assigns the provided PrimitiveType value to the fhirVersion 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 if defined; else undefined
CodeSystem Enumeration: FhirVersionEnum
Assigns the provided primitive value to the fhirVersion 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 mapping property value as a StructureDefinitionMappingComponent array
Assigns the provided StructureDefinitionMappingComponent array value to the mapping property.
the mapping array value
this
InvalidTypeError for invalid data types
Add the provided StructureDefinitionMappingComponent value to the mapping array property.
the mapping value
this
InvalidTypeError for invalid data types
true if the mapping property exists and has a value; false otherwise
the kind property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: StructureDefinitionKindEnum
Assigns the provided EnumCodeType value to the kind property.
the kind value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: StructureDefinitionKindEnum
true if the kind property exists and has a value; false otherwise
the kind property value as a CodeType if defined; else null
CodeSystem Enumeration: StructureDefinitionKindEnum
Assigns the provided PrimitiveType value to the kind property.
the kind value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: StructureDefinitionKindEnum
true if the kind property exists and has a value; false otherwise
the kind property value as a fhirCode if defined; else null
CodeSystem Enumeration: StructureDefinitionKindEnum
Assigns the provided primitive value to the kind property.
the kind value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: StructureDefinitionKindEnum
true if the kind property exists and has a value; false otherwise
the abstract_ property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the abstract_ property.
the abstract_ value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the abstract_ property exists and has a value; false otherwise
the abstract_ property value as a fhirBoolean if defined; else null
Assigns the provided primitive value to the abstract_ property.
the abstract_ value
this
PrimitiveTypeError for invalid primitive types
true if the abstract_ property exists and has a value; false otherwise
the context property value as a StructureDefinitionContextComponent array
Assigns the provided StructureDefinitionContextComponent array value to the context property.
the context array value
this
InvalidTypeError for invalid data types
Add the provided StructureDefinitionContextComponent value to the context array property.
the context value
this
InvalidTypeError for invalid data types
true if the context property exists and has a value; false otherwise
the contextInvariant property value as a StringType array
Assigns the provided StringType array value to the contextInvariant property.
the contextInvariant array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided StringType value to the contextInvariant array property.
the contextInvariant value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the contextInvariant property exists and has a value; false otherwise
the contextInvariant property value as a fhirString array
Assigns the provided primitive value array to the contextInvariant property.
the contextInvariant value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the contextInvariant array property.
the contextInvariant value
this
PrimitiveTypeError for invalid primitive types
true if the contextInvariant property exists and has a value; false otherwise
the type_ property value as a UriType object if defined; else an empty UriType object
Assigns the provided PrimitiveType value to the type_ property.
the type_ value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the type_ property exists and has a value; false otherwise
the type_ property value as a fhirUri if defined; else null
Assigns the provided primitive value to the type_ property.
the type_ value
this
PrimitiveTypeError for invalid primitive types
true if the type_ property exists and has a value; false otherwise
the baseDefinition property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the baseDefinition property.
the baseDefinition value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the baseDefinition property exists and has a value; false otherwise
the baseDefinition property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the baseDefinition property.
the baseDefinition value
this
PrimitiveTypeError for invalid primitive types
true if the baseDefinition property exists and has a value; false otherwise
the derivation property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: TypeDerivationRuleEnum
Assigns the provided EnumCodeType value to the derivation property.
the derivation value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: TypeDerivationRuleEnum
true if the derivation property exists and has a value; false otherwise
the derivation property value as a CodeType if defined; else undefined
CodeSystem Enumeration: TypeDerivationRuleEnum
Assigns the provided PrimitiveType value to the derivation property.
the derivation value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: TypeDerivationRuleEnum
true if the derivation property exists and has a value; false otherwise
the derivation property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: TypeDerivationRuleEnum
Assigns the provided primitive value to the derivation property.
the derivation value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: TypeDerivationRuleEnum
true if the derivation property exists and has a value; false otherwise
the snapshot property value as a StructureDefinitionSnapshotComponent object if defined; else an empty StructureDefinitionSnapshotComponent object
Assigns the provided Snapshot object value to the snapshot property.
the snapshot object value
this
InvalidTypeError for invalid data types
true if the snapshot property exists and has a value; false otherwise
the differential property value as a StructureDefinitionDifferentialComponent object if defined; else an empty StructureDefinitionDifferentialComponent object
Assigns the provided Differential object value to the differential property.
the differential object value
this
InvalidTypeError for invalid data types
true if the differential 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 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 contact property
PrivateinitInitialize the useContext property
PrivateinitInitialize the jurisdiction property
PrivateinitInitialize the keyword property
PrivateinitInitialize the mapping property
PrivateinitInitialize the context property
PrivateinitInitialize the contextInvariant property
StructureDefinition Class
Remarks
A definition of a FHIR structure. This resource is used to describe the underlying resources, data types defined in FHIR, and also for describing extensions and constraints on resources and data types.
FHIR Specification
See
FHIR StructureDefinition