Private OptionalurlCapabilityStatement.url Element
FHIR Specification
uriPrivate OptionalversionCapabilityStatement.version Element
FHIR Specification
stringPrivate OptionalnameCapabilityStatement.name Element
FHIR Specification
stringPrivate OptionaltitleCapabilityStatement.title Element
FHIR Specification
stringPrivate ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusCapabilityStatement.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalexperimentalCapabilityStatement.experimental Element
FHIR Specification
booleanPrivatedateCapabilityStatement.date Element
FHIR Specification
dateTimePrivate OptionalpublisherCapabilityStatement.publisher Element
FHIR Specification
stringPrivate OptionalcontactCapabilityStatement.contact Element
FHIR Specification
ContactDetailPrivate OptionaldescriptionCapabilityStatement.description Element
FHIR Specification
markdownPrivate OptionaluseCapabilityStatement.useContext Element
FHIR Specification
UsageContextPrivate OptionaljurisdictionCapabilityStatement.jurisdiction Element
FHIR Specification
CodeableConceptPrivate OptionalpurposeCapabilityStatement.purpose Element
FHIR Specification
markdownPrivate OptionalcopyrightCapabilityStatement.copyright Element
FHIR Specification
markdownPrivate ReadonlycapabilityFHIR CodeSystem: CapabilityStatementKind
PrivatekindCapabilityStatement.kind Element
FHIR Specification
codeCodeSystem Enumeration: CapabilityStatementKindEnum
Private OptionalinstantiatesCapabilityStatement.instantiates Element
FHIR Specification
canonical
Private OptionalimportsCapabilityStatement.imports Element
FHIR Specification
canonical
Private OptionalsoftwareCapabilityStatement.software Element
FHIR Specification
BackboneElementPrivate OptionalimplementationCapabilityStatement.implementation Element
FHIR Specification
BackboneElementPrivate ReadonlyfhirFHIR CodeSystem: FhirVersion
PrivatefhirCapabilityStatement.fhirVersion Element
FHIR Specification
codeCodeSystem Enumeration: FhirVersionEnum
PrivateformatCapabilityStatement.format Element
FHIR Specification
codePrivate OptionalpatchCapabilityStatement.patchFormat Element
FHIR Specification
codePrivate OptionalimplementationCapabilityStatement.implementationGuide Element
FHIR Specification
canonical
Private OptionalrestCapabilityStatement.rest Element
FHIR Specification
BackboneElementPrivate OptionalmessagingCapabilityStatement.messaging Element
FHIR Specification
BackboneElementPrivate OptionaldocumentCapabilityStatement.document Element
StaticparseParse the provided CapabilityStatement JSON to instantiate the CapabilityStatement data model.
JSON representing FHIR CapabilityStatement
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to CapabilityStatement
CapabilityStatement data model or undefined for CapabilityStatement
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 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 null
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 kind property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: CapabilityStatementKindEnum
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: CapabilityStatementKindEnum
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: CapabilityStatementKindEnum
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: CapabilityStatementKindEnum
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: CapabilityStatementKindEnum
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: CapabilityStatementKindEnum
true if the kind property exists and has a value; false otherwise
the instantiates property value as a CanonicalType array
Assigns the provided CanonicalType array value to the instantiates property.
the instantiates array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the instantiates array property.
the instantiates value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the instantiates property exists and has a value; false otherwise
the instantiates property value as a fhirCanonical array
Assigns the provided primitive value array to the instantiates property.
the instantiates value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the instantiates array property.
the instantiates value
this
PrimitiveTypeError for invalid primitive types
true if the instantiates property exists and has a value; false otherwise
the imports property value as a CanonicalType array
Assigns the provided CanonicalType array value to the imports property.
the imports array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the imports array property.
the imports value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the imports property exists and has a value; false otherwise
the imports property value as a fhirCanonical array
Assigns the provided primitive value array to the imports property.
the imports value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the imports array property.
the imports value
this
PrimitiveTypeError for invalid primitive types
true if the imports property exists and has a value; false otherwise
the software property value as a CapabilityStatementSoftwareComponent object if defined; else an empty CapabilityStatementSoftwareComponent object
Assigns the provided Software object value to the software property.
the software object value
this
InvalidTypeError for invalid data types
true if the software property exists and has a value; false otherwise
the implementation property value as a CapabilityStatementImplementationComponent object if defined; else an empty CapabilityStatementImplementationComponent object
Assigns the provided Implementation object value to the implementation property.
the implementation object value
this
InvalidTypeError for invalid data types
true if the implementation property exists and has a value; false otherwise
the fhirVersion property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: FhirVersionEnum
Assigns the provided EnumCodeType 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 CodeType if defined; else null
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 null
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 format property value as a CodeType array
Assigns the provided CodeType array value to the format property.
the format array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CodeType value to the format array property.
the format value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the format property exists and has a value; false otherwise
the format property value as a fhirCode array
Assigns the provided primitive value array to the format property.
the format value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the format array property.
the format value
this
PrimitiveTypeError for invalid primitive types
true if the format property exists and has a value; false otherwise
the patchFormat property value as a CodeType array
Assigns the provided CodeType array value to the patchFormat property.
the patchFormat array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CodeType value to the patchFormat array property.
the patchFormat value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the patchFormat property exists and has a value; false otherwise
the patchFormat property value as a fhirCode array
Assigns the provided primitive value array to the patchFormat property.
the patchFormat value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the patchFormat array property.
the patchFormat value
this
PrimitiveTypeError for invalid primitive types
true if the patchFormat property exists and has a value; false otherwise
the implementationGuide property value as a CanonicalType array
Assigns the provided CanonicalType array value to the implementationGuide property.
the implementationGuide array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the implementationGuide array property.
the implementationGuide value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the implementationGuide property exists and has a value; false otherwise
the implementationGuide property value as a fhirCanonical array
Assigns the provided primitive value array to the implementationGuide property.
the implementationGuide value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the implementationGuide array property.
the implementationGuide value
this
PrimitiveTypeError for invalid primitive types
true if the implementationGuide property exists and has a value; false otherwise
the rest property value as a CapabilityStatementRestComponent array
Assigns the provided CapabilityStatementRestComponent array value to the rest property.
the rest array value
this
InvalidTypeError for invalid data types
Add the provided CapabilityStatementRestComponent value to the rest array property.
the rest value
this
InvalidTypeError for invalid data types
true if the rest property exists and has a value; false otherwise
the messaging property value as a CapabilityStatementMessagingComponent array
Assigns the provided CapabilityStatementMessagingComponent array value to the messaging property.
the messaging array value
this
InvalidTypeError for invalid data types
Add the provided CapabilityStatementMessagingComponent value to the messaging array property.
the messaging value
this
InvalidTypeError for invalid data types
true if the messaging property exists and has a value; false otherwise
the document property value as a CapabilityStatementDocumentComponent array
Assigns the provided CapabilityStatementDocumentComponent array value to the document property.
the document array value
this
InvalidTypeError for invalid data types
Add the provided CapabilityStatementDocumentComponent value to the document array property.
the document value
this
InvalidTypeError for invalid data types
true if the document 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 instantiates property
PrivateinitInitialize the imports property
PrivateinitInitialize the format property
PrivateinitInitialize the patchFormat property
PrivateinitInitialize the implementationGuide property
PrivateinitInitialize the rest property
PrivateinitInitialize the messaging property
PrivateinitInitialize the document property
CapabilityStatement Class
Remarks
A Capability Statement documents a set of capabilities (behaviors) of a FHIR Server for a particular version of FHIR that may be used as a statement of actual server functionality or a statement of required or desired server implementation.
FHIR Specification
See
FHIR CapabilityStatement