Private OptionalurlActorDefinition.url Element
FHIR Specification
uriPrivate OptionalidentifierActorDefinition.identifier Element
FHIR Specification
IdentifierPrivate OptionalversionActorDefinition.version Element
FHIR Specification
stringPrivate OptionalversionActorDefinition.versionAlgorithm[x] Element
FHIR Specification
Private OptionalnameActorDefinition.name Element
FHIR Specification
stringPrivate OptionaltitleActorDefinition.title Element
FHIR Specification
stringPrivate ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusActorDefinition.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalexperimentalActorDefinition.experimental Element
FHIR Specification
booleanPrivate OptionaldateActorDefinition.date Element
FHIR Specification
dateTimePrivate OptionalpublisherActorDefinition.publisher Element
FHIR Specification
stringPrivate OptionalcontactActorDefinition.contact Element
FHIR Specification
ContactDetailPrivate OptionaldescriptionActorDefinition.description Element
FHIR Specification
markdownPrivate OptionaluseActorDefinition.useContext Element
FHIR Specification
UsageContextPrivate OptionaljurisdictionActorDefinition.jurisdiction Element
FHIR Specification
CodeableConceptPrivate OptionalpurposeActorDefinition.purpose Element
FHIR Specification
markdownPrivate OptionalcopyrightActorDefinition.copyright Element
FHIR Specification
markdownPrivate OptionalcopyrightActorDefinition.copyrightLabel Element
FHIR Specification
stringPrivate ReadonlyexamplescenarioFHIR CodeSystem: ExamplescenarioActorType
Privatetype_ActorDefinition.type Element
FHIR Specification
codeCodeSystem Enumeration: ExamplescenarioActorTypeEnum
Private OptionaldocumentationActorDefinition.documentation Element
FHIR Specification
markdownPrivate OptionalreferenceActorDefinition.reference Element
Private OptionalcapabilitiesActorDefinition.capabilities Element
FHIR Specification
canonical
Private OptionalderivedActorDefinition.derivedFrom Element
FHIR Specification
canonical
StaticparseParse the provided ActorDefinition JSON to instantiate the ActorDefinition data model.
JSON representing FHIR ActorDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to ActorDefinition
ActorDefinition data model or undefined for ActorDefinition
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 undefined
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 versionAlgorithm property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the versionAlgorithm property.
the versionAlgorithm object value
this
InvalidTypeError for invalid data types
true if the versionAlgorithm property exists and has a value; false otherwise
the versionAlgorithm property value as a StringType object if defined; else undefined
true if the versionAlgorithm property exists as a StringType and has a value; false otherwise
the versionAlgorithm property value as a Coding object if defined; else undefined
true if the versionAlgorithm property exists as a Coding 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 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 copyrightLabel property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the copyrightLabel property.
the copyrightLabel value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the copyrightLabel property exists and has a value; false otherwise
the copyrightLabel property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the copyrightLabel property.
the copyrightLabel value
this
PrimitiveTypeError for invalid primitive types
true if the copyrightLabel property exists and has a value; false otherwise
the type_ property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: ExamplescenarioActorTypeEnum
Assigns the provided EnumCodeType value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ExamplescenarioActorTypeEnum
true if the type_ property exists and has a value; false otherwise
the type_ property value as a CodeType if defined; else null
CodeSystem Enumeration: ExamplescenarioActorTypeEnum
Assigns the provided PrimitiveType value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ExamplescenarioActorTypeEnum
true if the type_ property exists and has a value; false otherwise
the type_ property value as a fhirCode if defined; else null
CodeSystem Enumeration: ExamplescenarioActorTypeEnum
Assigns the provided primitive value to the type_ property.
the type_ value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ExamplescenarioActorTypeEnum
true if the type_ property exists and has a value; false otherwise
the documentation property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the documentation property.
the documentation value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the documentation property exists and has a value; false otherwise
the documentation property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the documentation property.
the documentation value
this
PrimitiveTypeError for invalid primitive types
true if the documentation property exists and has a value; false otherwise
the reference property value as a UrlType array
Assigns the provided UrlType array value to the reference property.
the reference array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided UrlType value to the reference array property.
the reference value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the reference property exists and has a value; false otherwise
the reference property value as a fhirUrl array
Assigns the provided primitive value array to the reference property.
the reference value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the reference array property.
the reference value
this
PrimitiveTypeError for invalid primitive types
true if the reference property exists and has a value; false otherwise
the capabilities property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the capabilities property.
the capabilities value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the capabilities property exists and has a value; false otherwise
the capabilities property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the capabilities property.
the capabilities value
this
PrimitiveTypeError for invalid primitive types
true if the capabilities property exists and has a value; false otherwise
the derivedFrom property value as a CanonicalType array
Assigns the provided CanonicalType array value to the derivedFrom property.
the derivedFrom array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the derivedFrom array property.
the derivedFrom value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the derivedFrom property exists and has a value; false otherwise
the derivedFrom property value as a fhirCanonical array
Assigns the provided primitive value array to the derivedFrom property.
the derivedFrom value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the derivedFrom array property.
the derivedFrom value
this
PrimitiveTypeError for invalid primitive types
true if the derivedFrom 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 reference property
PrivateinitInitialize the derivedFrom property
ActorDefinition Class
Remarks
The ActorDefinition resource is used to describe an actor - a human or an application that plays a role in data exchange, and that may have obligations associated with the role the actor plays.
FHIR Specification
See
FHIR ActorDefinition