Private OptionalurlOperationDefinition.url Element
FHIR Specification
uriPrivate OptionalversionOperationDefinition.version Element
FHIR Specification
stringPrivatenameOperationDefinition.name Element
FHIR Specification
stringPrivate OptionaltitleOperationDefinition.title Element
FHIR Specification
stringPrivate ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusOperationDefinition.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private ReadonlyoperationFHIR CodeSystem: OperationKind
PrivatekindOperationDefinition.kind Element
FHIR Specification
codeCodeSystem Enumeration: OperationKindEnum
Private OptionalexperimentalOperationDefinition.experimental Element
FHIR Specification
booleanPrivate OptionaldateOperationDefinition.date Element
FHIR Specification
dateTimePrivate OptionalpublisherOperationDefinition.publisher Element
FHIR Specification
stringPrivate OptionalcontactOperationDefinition.contact Element
FHIR Specification
ContactDetailPrivate OptionaldescriptionOperationDefinition.description Element
FHIR Specification
markdownPrivate OptionaluseOperationDefinition.useContext Element
FHIR Specification
UsageContextPrivate OptionaljurisdictionOperationDefinition.jurisdiction Element
FHIR Specification
CodeableConceptPrivate OptionalpurposeOperationDefinition.purpose Element
FHIR Specification
markdownPrivate OptionalaffectsOperationDefinition.affectsState Element
FHIR Specification
booleanPrivatecodeOperationDefinition.code Element
Private OptionalcommentOperationDefinition.comment Element
Private OptionalbaseOperationDefinition.base Element
FHIR Specification
canonical
Private ReadonlyresourceFHIR CodeSystem: ResourceTypes
Private OptionalresourceOperationDefinition.resource Element
FHIR Specification
codeCodeSystem Enumeration: ResourceTypesEnum
PrivatesystemOperationDefinition.system Element
Privatetype_OperationDefinition.type Element
FHIR Specification
booleanPrivateinstance_OperationDefinition.instance Element
Private OptionalinputOperationDefinition.inputProfile Element
FHIR Specification
canonical
Private OptionaloutputOperationDefinition.outputProfile Element
FHIR Specification
canonical
Private OptionalparameterOperationDefinition.parameter Element
FHIR Specification
BackboneElementPrivate OptionaloverloadOperationDefinition.overload Element
FHIR Specification
BackboneElementStaticparseParse the provided OperationDefinition JSON to instantiate the OperationDefinition data model.
JSON representing FHIR OperationDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to OperationDefinition
OperationDefinition data model or undefined for OperationDefinition
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 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 kind property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: OperationKindEnum
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: OperationKindEnum
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: OperationKindEnum
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: OperationKindEnum
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: OperationKindEnum
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: OperationKindEnum
true if the kind 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 affectsState property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the affectsState property.
the affectsState value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the affectsState property exists and has a value; false otherwise
the affectsState property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the affectsState property.
the affectsState value
this
PrimitiveTypeError for invalid primitive types
true if the affectsState property exists and has a value; false otherwise
the code property value as a CodeType object if defined; else an empty CodeType object
Assigns the provided PrimitiveType value to the code property.
the code value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the code property exists and has a value; false otherwise
the code property value as a fhirCode if defined; else null
Assigns the provided primitive value to the code property.
the code value
this
PrimitiveTypeError for invalid primitive types
true if the code property exists and has a value; false otherwise
the comment property value as a MarkdownType object if defined; else an empty MarkdownType object
Assigns the provided PrimitiveType value to the comment property.
the comment value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the comment property exists and has a value; false otherwise
the comment property value as a fhirMarkdown if defined; else undefined
Assigns the provided primitive value to the comment property.
the comment value
this
PrimitiveTypeError for invalid primitive types
true if the comment property exists and has a value; false otherwise
the base property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the base property.
the base value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the base property exists and has a value; false otherwise
the base property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the base property.
the base value
this
PrimitiveTypeError for invalid primitive types
true if the base property exists and has a value; false otherwise
the resource property value as a EnumCodeType array
CodeSystem Enumeration: ResourceTypesEnum
Assigns the provided EnumCodeType array value to the resource property.
the resource array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ResourceTypesEnum
Add the provided EnumCodeType value to the resource array property.
the resource value
this
InvalidCodeError for invalid code value
CodeSystem Enumeration: ResourceTypesEnum
true if the resource property exists and has a value; false otherwise
the resource property value as a CodeType array
CodeSystem Enumeration: ResourceTypesEnum
Assigns the provided PrimitiveType array value to the resource property.
the resource array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ResourceTypesEnum
Add the provided PrimitiveType value to the resource array property.
the resource value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ResourceTypesEnum
true if the resource property exists and has a value; false otherwise
the resource property value as a fhirCode array
CodeSystem Enumeration: ResourceTypesEnum
Assigns the provided primitive value array to the resource property.
the resource value array
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ResourceTypesEnum
Add the provided primitive value to the resource array property.
the resource value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ResourceTypesEnum
true if the resource property exists and has a value; false otherwise
the system property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the system property.
the system value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the system property value as a fhirBoolean if defined; else null
Assigns the provided primitive value to the system property.
the system value
this
PrimitiveTypeError for invalid primitive types
true if the system property exists and has a value; false otherwise
the type_ property value as a BooleanType object if defined; else an empty BooleanType 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 fhirBoolean 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 instance_ property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the instance_ property.
the instance_ value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the instance_ property exists and has a value; false otherwise
the instance_ property value as a fhirBoolean if defined; else null
Assigns the provided primitive value to the instance_ property.
the instance_ value
this
PrimitiveTypeError for invalid primitive types
true if the instance_ property exists and has a value; false otherwise
the inputProfile property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the inputProfile property.
the inputProfile value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the inputProfile property exists and has a value; false otherwise
the inputProfile property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the inputProfile property.
the inputProfile value
this
PrimitiveTypeError for invalid primitive types
true if the inputProfile property exists and has a value; false otherwise
the outputProfile property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the outputProfile property.
the outputProfile value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the outputProfile property exists and has a value; false otherwise
the outputProfile property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the outputProfile property.
the outputProfile value
this
PrimitiveTypeError for invalid primitive types
true if the outputProfile property exists and has a value; false otherwise
the parameter property value as a OperationDefinitionParameterComponent array
Assigns the provided OperationDefinitionParameterComponent array value to the parameter property.
the parameter array value
this
InvalidTypeError for invalid data types
Add the provided OperationDefinitionParameterComponent value to the parameter array property.
the parameter value
this
InvalidTypeError for invalid data types
true if the parameter property exists and has a value; false otherwise
the overload property value as a OperationDefinitionOverloadComponent array
Assigns the provided OperationDefinitionOverloadComponent array value to the overload property.
the overload array value
this
InvalidTypeError for invalid data types
Add the provided OperationDefinitionOverloadComponent value to the overload array property.
the overload value
this
InvalidTypeError for invalid data types
true if the overload 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 contact property
PrivateinitInitialize the useContext property
PrivateinitInitialize the jurisdiction property
PrivateinitInitialize the resource property
PrivateinitInitialize the parameter property
PrivateinitInitialize the overload property
OperationDefinition Class
Remarks
A formal computable definition of an operation (on the RESTful interface) or a named query (using the search interaction).
FHIR Specification
See
FHIR OperationDefinition