Private ReadonlyfhirFHIR CodeSystem: FhirTypes
Privatetype_CapabilityStatement.rest.resource.type Element
FHIR Specification
codeCodeSystem Enumeration: FhirTypesEnum
Private OptionalprofileCapabilityStatement.rest.resource.profile Element
FHIR Specification
.rest.resource.supportedProfile must conform to this profile.canonical
Private OptionalsupportedCapabilityStatement.rest.resource.supportedProfile Element
FHIR Specification
.rest.resource.profile element if it is present. The resource profile is a system-wide profile applied across all instances of the resource supported by the system. A supported profile is a statement about the functionality of the data and services provided by the server (or used by the client) for a particular set of use cases and will not necessarily apply to all data consumed or exposed by the server.canonical
Private OptionaldocumentationCapabilityStatement.rest.resource.documentation Element
Private OptionalinteractionCapabilityStatement.rest.resource.interaction Element
FHIR Specification
BackboneElementPrivate ReadonlyversioningFHIR CodeSystem: VersioningPolicy
Private OptionalversioningCapabilityStatement.rest.resource.versioning Element
FHIR Specification
codeCodeSystem Enumeration: VersioningPolicyEnum
Private OptionalreadCapabilityStatement.rest.resource.readHistory Element
FHIR Specification
booleanPrivate OptionalupdateCapabilityStatement.rest.resource.updateCreate Element
FHIR Specification
booleanPrivate OptionalconditionalCapabilityStatement.rest.resource.conditionalCreate Element
FHIR Specification
booleanPrivate ReadonlyconditionalFHIR CodeSystem: ConditionalReadStatus
Private OptionalconditionalCapabilityStatement.rest.resource.conditionalRead Element
FHIR Specification
codeCodeSystem Enumeration: ConditionalReadStatusEnum
Private OptionalconditionalCapabilityStatement.rest.resource.conditionalUpdate Element
FHIR Specification
booleanPrivate OptionalconditionalCapabilityStatement.rest.resource.conditionalPatch Element
FHIR Specification
booleanPrivate ReadonlyconditionalFHIR CodeSystem: ConditionalDeleteStatus
Private OptionalconditionalCapabilityStatement.rest.resource.conditionalDelete Element
FHIR Specification
codeCodeSystem Enumeration: ConditionalDeleteStatusEnum
Private ReadonlyreferenceFHIR CodeSystem: ReferenceHandlingPolicy
Private OptionalreferenceCapabilityStatement.rest.resource.referencePolicy Element
FHIR Specification
codeCodeSystem Enumeration: ReferenceHandlingPolicyEnum
Private OptionalsearchCapabilityStatement.rest.resource.searchInclude Element
FHIR Specification
_include support helps set conformance expectations for the desired system. Still, it is a level of detail that might not be exposed by production servers or clients when using CapabilityStatement to describe an actual implementation. If this list is empty, the server does not support includes. Support for iterative (a.k.a., recursive) _include is communicated by listing the iterative includes values supported by the server in the searchInclude element of the "root" resource type. For example, to support the following search: GET [base]/CarePlan?_include=CarePlan:activity-reference:DeviceRequest&_include:iterate=DeviceRequest:device These values would be listed as part of capabilities for "CarePlan": "searchInclude" : ["CarePlan:activity-reference:DeviceRequest","DeviceRequest:device"],stringPrivate OptionalsearchCapabilityStatement.rest.resource.searchRevInclude Element
FHIR Specification
CapabilityStatement.rest.resource.searchInclude comments.stringPrivate OptionalsearchCapabilityStatement.rest.resource.searchParam Element
FHIR Specification
BackboneElementPrivate OptionaloperationCapabilityStatement.rest.resource.operation Element
FHIR Specification
BackboneElementStaticparseParse the provided CapabilityStatementRestResourceComponent JSON to instantiate the CapabilityStatementRestResourceComponent data model.
JSON representing FHIR CapabilityStatementRestResourceComponent
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CapabilityStatementRestResourceComponent
CapabilityStatementRestResourceComponent data model or undefined for CapabilityStatementRestResourceComponent
JsonError if the provided JSON is not a valid JSON object
the type_ property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: FhirTypesEnum
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: FhirTypesEnum
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: FhirTypesEnum
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: FhirTypesEnum
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: FhirTypesEnum
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: FhirTypesEnum
true if the type_ property exists and has a value; false otherwise
the profile property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the profile 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 if defined; else undefined
Assigns the provided primitive value to the profile property.
the profile value
this
PrimitiveTypeError for invalid primitive types
true if the profile property exists and has a value; false otherwise
the supportedProfile property value as a CanonicalType array
Assigns the provided CanonicalType array value to the supportedProfile property.
the supportedProfile array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the supportedProfile array property.
the supportedProfile value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the supportedProfile property exists and has a value; false otherwise
the supportedProfile property value as a fhirCanonical array
Assigns the provided primitive value array to the supportedProfile property.
the supportedProfile value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the supportedProfile array property.
the supportedProfile value
this
PrimitiveTypeError for invalid primitive types
true if the supportedProfile 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 interaction property value as a CapabilityStatementRestResourceInteractionComponent array
Assigns the provided CapabilityStatementRestResourceInteractionComponent array value to the interaction property.
the interaction array value
this
InvalidTypeError for invalid data types
Add the provided CapabilityStatementRestResourceInteractionComponent value to the interaction array property.
the interaction value
this
InvalidTypeError for invalid data types
true if the interaction property exists and has a value; false otherwise
the versioning property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: VersioningPolicyEnum
Assigns the provided EnumCodeType value to the versioning property.
the versioning value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: VersioningPolicyEnum
true if the versioning property exists and has a value; false otherwise
the versioning property value as a CodeType if defined; else undefined
CodeSystem Enumeration: VersioningPolicyEnum
Assigns the provided PrimitiveType value to the versioning property.
the versioning value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: VersioningPolicyEnum
true if the versioning property exists and has a value; false otherwise
the versioning property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: VersioningPolicyEnum
Assigns the provided primitive value to the versioning property.
the versioning value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: VersioningPolicyEnum
true if the versioning property exists and has a value; false otherwise
the readHistory property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the readHistory property.
the readHistory value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the readHistory property exists and has a value; false otherwise
the readHistory property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the readHistory property.
the readHistory value
this
PrimitiveTypeError for invalid primitive types
true if the readHistory property exists and has a value; false otherwise
the updateCreate property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the updateCreate property.
the updateCreate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the updateCreate property exists and has a value; false otherwise
the updateCreate property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the updateCreate property.
the updateCreate value
this
PrimitiveTypeError for invalid primitive types
true if the updateCreate property exists and has a value; false otherwise
the conditionalCreate property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the conditionalCreate property.
the conditionalCreate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the conditionalCreate property exists and has a value; false otherwise
the conditionalCreate property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the conditionalCreate property.
the conditionalCreate value
this
PrimitiveTypeError for invalid primitive types
true if the conditionalCreate property exists and has a value; false otherwise
the conditionalRead property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: ConditionalReadStatusEnum
Assigns the provided EnumCodeType value to the conditionalRead property.
the conditionalRead value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: ConditionalReadStatusEnum
true if the conditionalRead property exists and has a value; false otherwise
the conditionalRead property value as a CodeType if defined; else undefined
CodeSystem Enumeration: ConditionalReadStatusEnum
Assigns the provided PrimitiveType value to the conditionalRead property.
the conditionalRead value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ConditionalReadStatusEnum
true if the conditionalRead property exists and has a value; false otherwise
the conditionalRead property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: ConditionalReadStatusEnum
Assigns the provided primitive value to the conditionalRead property.
the conditionalRead value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ConditionalReadStatusEnum
true if the conditionalRead property exists and has a value; false otherwise
the conditionalUpdate property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the conditionalUpdate property.
the conditionalUpdate value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the conditionalUpdate property exists and has a value; false otherwise
the conditionalUpdate property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the conditionalUpdate property.
the conditionalUpdate value
this
PrimitiveTypeError for invalid primitive types
true if the conditionalUpdate property exists and has a value; false otherwise
the conditionalPatch property value as a BooleanType object if defined; else an empty BooleanType object
Assigns the provided PrimitiveType value to the conditionalPatch property.
the conditionalPatch value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the conditionalPatch property exists and has a value; false otherwise
the conditionalPatch property value as a fhirBoolean if defined; else undefined
Assigns the provided primitive value to the conditionalPatch property.
the conditionalPatch value
this
PrimitiveTypeError for invalid primitive types
true if the conditionalPatch property exists and has a value; false otherwise
the conditionalDelete property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: ConditionalDeleteStatusEnum
Assigns the provided EnumCodeType value to the conditionalDelete property.
the conditionalDelete value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: ConditionalDeleteStatusEnum
true if the conditionalDelete property exists and has a value; false otherwise
the conditionalDelete property value as a CodeType if defined; else undefined
CodeSystem Enumeration: ConditionalDeleteStatusEnum
Assigns the provided PrimitiveType value to the conditionalDelete property.
the conditionalDelete value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ConditionalDeleteStatusEnum
true if the conditionalDelete property exists and has a value; false otherwise
the conditionalDelete property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: ConditionalDeleteStatusEnum
Assigns the provided primitive value to the conditionalDelete property.
the conditionalDelete value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ConditionalDeleteStatusEnum
true if the conditionalDelete property exists and has a value; false otherwise
the referencePolicy property value as a EnumCodeType array
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
Assigns the provided EnumCodeType array value to the referencePolicy property.
the referencePolicy array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
Add the provided EnumCodeType value to the referencePolicy array property.
the referencePolicy value
this
InvalidCodeError for invalid code value
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
true if the referencePolicy property exists and has a value; false otherwise
the referencePolicy property value as a CodeType array
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
Assigns the provided PrimitiveType array value to the referencePolicy property.
the referencePolicy array value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
Add the provided PrimitiveType value to the referencePolicy array property.
the referencePolicy value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
true if the referencePolicy property exists and has a value; false otherwise
the referencePolicy property value as a fhirCode array
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
Assigns the provided primitive value array to the referencePolicy property.
the referencePolicy value array
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
Add the provided primitive value to the referencePolicy array property.
the referencePolicy value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: ReferenceHandlingPolicyEnum
true if the referencePolicy property exists and has a value; false otherwise
the searchInclude property value as a StringType array
Assigns the provided StringType array value to the searchInclude property.
the searchInclude array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided StringType value to the searchInclude array property.
the searchInclude value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the searchInclude property exists and has a value; false otherwise
the searchInclude property value as a fhirString array
Assigns the provided primitive value array to the searchInclude property.
the searchInclude value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the searchInclude array property.
the searchInclude value
this
PrimitiveTypeError for invalid primitive types
true if the searchInclude property exists and has a value; false otherwise
the searchRevInclude property value as a StringType array
Assigns the provided StringType array value to the searchRevInclude property.
the searchRevInclude array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided StringType value to the searchRevInclude array property.
the searchRevInclude value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the searchRevInclude property exists and has a value; false otherwise
the searchRevInclude property value as a fhirString array
Assigns the provided primitive value array to the searchRevInclude property.
the searchRevInclude value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the searchRevInclude array property.
the searchRevInclude value
this
PrimitiveTypeError for invalid primitive types
true if the searchRevInclude property exists and has a value; false otherwise
the searchParam property value as a CapabilityStatementRestResourceSearchParamComponent array
Assigns the provided CapabilityStatementRestResourceSearchParamComponent array value to the searchParam property.
the searchParam array value
this
InvalidTypeError for invalid data types
Add the provided CapabilityStatementRestResourceSearchParamComponent value to the searchParam array property.
the searchParam value
this
InvalidTypeError for invalid data types
true if the searchParam property exists and has a value; false otherwise
the operation property value as a CapabilityStatementRestResourceOperationComponent array
Assigns the provided CapabilityStatementRestResourceOperationComponent array value to the operation property.
the operation array value
this
InvalidTypeError for invalid data types
Add the provided CapabilityStatementRestResourceOperationComponent value to the operation array property.
the operation value
this
InvalidTypeError for invalid data types
true if the operation 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 supportedProfile property
PrivateinitInitialize the interaction property
PrivateinitInitialize the referencePolicy property
PrivateinitInitialize the searchInclude property
PrivateinitInitialize the searchRevInclude property
PrivateinitInitialize the searchParam property
PrivateinitInitialize the operation property
CapabilityStatementRestResourceComponent Class
Remarks
FHIR Specification
See
FHIR CapabilityStatement