Class Subscription

Subscription Class

Remarks

The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.

FHIR Specification

Short: Notification about a SubscriptionTopic
Definition: The subscription resource describes a particular client's request to be notified about a SubscriptionTopic.
FHIR Version: 5.0.0

Index

Constructors

constructor

Properties

identifier? name? subscriptionStatusEnum status topic contact? end? managingEntity? reason? filterBy? channelType endpoint? parameter? heartbeatPeriod? timeout? contentType? subscriptionPayloadContentEnum content? maxCount?

Methods

parse getIdentifier setIdentifier addIdentifier hasIdentifier getNameElement setNameElement hasNameElement getName setName hasName getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getTopicElement setTopicElement hasTopicElement getTopic setTopic hasTopic getContact setContact addContact hasContact getEndElement setEndElement hasEndElement getEnd setEnd hasEnd getManagingEntity setManagingEntity hasManagingEntity getReasonElement setReasonElement hasReasonElement getReason setReason hasReason getFilterBy setFilterBy addFilterBy hasFilterBy getChannelType setChannelType hasChannelType getEndpointElement setEndpointElement hasEndpointElement getEndpoint setEndpoint hasEndpoint getParameter setParameter addParameter hasParameter getHeartbeatPeriodElement setHeartbeatPeriodElement hasHeartbeatPeriodElement getHeartbeatPeriod setHeartbeatPeriod hasHeartbeatPeriod getTimeoutElement setTimeoutElement hasTimeoutElement getTimeout setTimeout hasTimeout getContentTypeElement setContentTypeElement hasContentTypeElement getContentType setContentType hasContentType getContentEnumType setContentEnumType hasContentEnumType getContentElement setContentElement hasContentElement getContent setContent hasContent getMaxCountElement setMaxCountElement hasMaxCountElement getMaxCount setMaxCount hasMaxCount fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initContact initFilterBy initParameter

Constructors

constructor

new Subscription(
    status?: null | string | CodeType | EnumCodeType,
    topic?: null | string | CanonicalType,
    channelType?: null | Coding,
): Subscription
Parameters
- status: null | string | CodeType | EnumCodeType = null
- topic: null | string | CanonicalType = null
- channelType: null | Coding = null
Returns Subscription
Overrides DomainResource.constructor
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:113

Properties

`Private` `Optional`identifier

identifier?: Identifier[]

Subscription.identifier Element

Remarks

FHIR Specification

Short: Additional identifiers (business identifier)
Definition: A formal identifier that is used to identify this code system when it is represented in other formats, or referenced in a specification, model, design or an instance.
FHIR Type: Identifier
Cardinality: 0..*
isModifier: false
isSummary: true

`Private` `Optional`name

name?: StringType

Subscription.name Element

Remarks

FHIR Specification

Short: Human readable name for this subscription
Definition: A natural language name identifying the subscription.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Readonly`subscriptionStatusEnum

subscriptionStatusEnum: SubscriptionStatusEnum

FHIR CodeSystem: SubscriptionStatus

See

SubscriptionStatusEnum

`Private`status

status: null | EnumCodeType

Subscription.status Element

Remarks

FHIR Specification

Short: requested | active | error | off | entered-in-error
Definition: The status of the subscription, which marks the server state for managing the subscription.
Comment: A client can only submit subscription resources in the requested or off state. Only the server can move a subscription from requested to active, and then to error. Either the server or the client can turn a subscription off. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
FHIR Type: code
Cardinality: 1..1
isModifier: true
isModifierReason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
isSummary: true

See

CodeSystem Enumeration: SubscriptionStatusEnum

`Private`topic

topic: null | CanonicalType

Subscription.topic Element

Remarks

FHIR Specification

Short: Reference to the subscription topic being subscribed to
Definition: The reference to the subscription topic to be notified about.
FHIR Type: canonical
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/SubscriptionTopic', ]
Cardinality: 1..1
isModifier: false
isSummary: true

`Private` `Optional`contact

contact?: ContactPoint[]

Subscription.contact Element

Remarks

FHIR Specification

Short: Contact details for source (e.g. troubleshooting)
Definition: Contact details for a human to contact about the subscription. The primary use of this for system administrator troubleshooting.
FHIR Type: ContactPoint
Cardinality: 0..*
isModifier: false
isSummary: true

`Private` `Optional`end

end?: InstantType

Subscription.end Element

Remarks

FHIR Specification

Short: When to automatically delete the subscription
Definition: The time for the server to turn the subscription off.
Comment: The server is permitted to deviate from this time but should observe it.
FHIR Type: instant
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`managingEntity

managingEntity?: Reference

Subscription.managingEntity Element

Remarks

FHIR Specification

Short: Entity responsible for Subscription changes
Definition: Entity with authorization to make subsequent revisions to the Subscription and also determines what data the subscription is authorized to disclose.
FHIR Type: Reference
- TargetProfiles: [ 'http://hl7.org/fhir/StructureDefinition/CareTeam', 'http://hl7.org/fhir/StructureDefinition/HealthcareService', 'http://hl7.org/fhir/StructureDefinition/Organization', 'http://hl7.org/fhir/StructureDefinition/RelatedPerson', 'http://hl7.org/fhir/StructureDefinition/Patient', 'http://hl7.org/fhir/StructureDefinition/Practitioner', 'http://hl7.org/fhir/StructureDefinition/PractitionerRole', ]
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`reason

reason?: StringType

Subscription.reason Element

Remarks

FHIR Specification

Short: Description of why this subscription was created
Definition: A description of why this subscription is defined.
FHIR Type: string
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`filterBy

filterBy?: SubscriptionFilterByComponent[]

Subscription.filterBy Element

Remarks

FHIR Specification

Short: Criteria for narrowing the subscription topic stream
Definition: The filter properties to be applied to narrow the subscription topic stream. When multiple filters are applied, evaluates to true if all the conditions applicable to that resource are met; otherwise it returns false (i.e., logical AND).
FHIR Type: BackboneElement
Cardinality: 0..*
isModifier: false
isSummary: true

`Private`channelType

channelType: null | Coding

Subscription.channelType Element

Remarks

FHIR Specification

Short: Channel type for notifications
Definition: The type of channel to send notifications on.
FHIR Type: Coding
Cardinality: 1..1
isModifier: false
isSummary: true

`Private` `Optional`endpoint

endpoint?: UrlType

Subscription.endpoint Element

Remarks

FHIR Specification

Short: Where the channel points to
Definition: The url that describes the actual end-point to send notifications to.
Comment: For rest-hook the end-point must be an http: or https: URL; for websockets, ws: or wss:; for email, a mailto: url; and for message the endpoint can be in any form of url the server understands (usually, http/s: or mllp:). The URI is allowed to be relative; in which case, it is relative to the server end-point (since there may be more than one, clients should avoid using relative URIs).
FHIR Type: url
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`parameter

parameter?: SubscriptionParameterComponent[]

Subscription.parameter Element

Remarks

FHIR Specification

Short: Channel type
Definition: Channel-dependent information to send as part of the notification (e.g., HTTP Headers).
Comment: Exactly what these mean depend on the channel type. They can convey additional information to the server or recipient and/or meet security requirements; for example, support of multiple headers in the outgoing notifications for rest-hook type subscriptions. Note that names are not required to be unique, but channel definitions can impose restrictions.
FHIR Type: BackboneElement
Cardinality: 0..*
isModifier: false
isSummary: false

`Private` `Optional`heartbeatPeriod

heartbeatPeriod?: UnsignedIntType

Subscription.heartbeatPeriod Element

Remarks

FHIR Specification

Short: Interval in seconds to send 'heartbeat' notification
Definition: If present, a 'heartbeat' notification (keep-alive) is sent via this channel with an interval period equal to this elements integer value in seconds. If not present, a heartbeat notification is not sent.
FHIR Type: unsignedInt
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`timeout

timeout?: UnsignedIntType

Subscription.timeout Element

Remarks

FHIR Specification

Short: Timeout in seconds to attempt notification delivery
Definition: If present, the maximum amount of time a server will allow before failing a notification attempt.
FHIR Type: unsignedInt
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Optional`contentType

contentType?: CodeType

Subscription.contentType Element

Remarks

FHIR Specification

Short: MIME type to send, or omit for no payload
Definition: The MIME type to send the payload in - e.g., application/fhir+xml or application/fhir+json. Note that: * clients may request notifications in a specific FHIR version by using the FHIR Version Parameter - e.g., application/fhir+json; fhirVersion=4.0. * additional MIME types can be allowed by channels - e.g., text/plain and text/html are defined by the Email channel.
FHIR Type: code
Cardinality: 0..1
isModifier: false
isSummary: true

`Private` `Readonly`subscriptionPayloadContentEnum

subscriptionPayloadContentEnum: SubscriptionPayloadContentEnum

FHIR CodeSystem: SubscriptionPayloadContent

See

SubscriptionPayloadContentEnum

`Private` `Optional`content

content?: EnumCodeType

Subscription.content Element

Remarks

FHIR Specification

Short: empty | id-only | full-resource
Definition: How much of the resource content to deliver in the notification payload. The choices are an empty payload, only the resource id, or the full resource content.
Comment: Sending the payload has obvious security implications. The server is responsible for ensuring that the content is appropriately secured.
FHIR Type: code
Cardinality: 0..1
isModifier: false
isSummary: true

See

CodeSystem Enumeration: SubscriptionPayloadContentEnum

`Private` `Optional`maxCount

maxCount?: PositiveIntType

Subscription.maxCount Element

Remarks

FHIR Specification

Short: Maximum number of events that can be combined in a single notification
Definition: If present, the maximum number of events that will be included in a notification bundle. Note that this is not a strict limit on the number of entries in a bundle, as dependent resources can be included.
FHIR Type: positiveInt
Cardinality: 0..1
isModifier: false
isSummary: true

Methods

`Static`parse

parse(sourceJson: Value, optSourceField?: string): undefined | Subscription
Parse the provided Subscription JSON to instantiate the Subscription data model.
Parameters
- sourceJson: Value
  JSON representing FHIR Subscription
- OptionaloptSourceField: string
  Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Subscription
Returns undefined | Subscription
Subscription data model or undefined for Subscription

Throws
JsonError if the provided JSON is not a valid JSON object
Overrides DomainResource.parse
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:149

getIdentifier

getIdentifier(): Identifier[]
Returns Identifier[]
the identifier property value as a Identifier array
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:641

setIdentifier

setIdentifier(value: undefined | Identifier[]): this
Assigns the provided Identifier array value to the identifier property.
Parameters
- value: undefined | Identifier[]
  the identifier array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:652

addIdentifier

addIdentifier(value: undefined | Identifier): this
Add the provided Identifier value to the identifier array property.
Parameters
- value: undefined | Identifier
  the identifier value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:670

hasIdentifier

hasIdentifier(): boolean
Returns boolean
true if the identifier property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:683

getNameElement

getNameElement(): StringType
Returns StringType
the name property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:699

setNameElement

setNameElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the name property.
Parameters
- element: undefined | StringType
  the name value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:711

hasNameElement

hasNameElement(): boolean
Returns boolean
true if the name property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:725

getName

getName(): undefined | string
Returns undefined | string
the name property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:732

setName

setName(value: undefined | string): this
Assigns the provided primitive value to the name property.
Parameters
- value: undefined | string
  the name value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:743

hasName

hasName(): boolean
Returns boolean
true if the name property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:756

getStatusEnumType

getStatusEnumType(): null | EnumCodeType
Returns null | EnumCodeType
the status property value as a EnumCodeType if defined; else null

See
CodeSystem Enumeration: SubscriptionStatusEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:765

setStatusEnumType

setStatusEnumType(enumType: undefined | null | EnumCodeType): this
Assigns the provided EnumCodeType value to the status property.
Parameters
- enumType: undefined | null | EnumCodeType
  the status value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: SubscriptionStatusEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:779

hasStatusEnumType

hasStatusEnumType(): boolean
Returns boolean
true if the status property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:793

getStatusElement

getStatusElement(): null | CodeType
Returns null | CodeType
the status property value as a CodeType if defined; else null

See
CodeSystem Enumeration: SubscriptionStatusEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:802

setStatusElement

setStatusElement(element: undefined | null | CodeType): this
Assigns the provided PrimitiveType value to the status property.
Parameters
- element: undefined | null | CodeType
  the status value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: SubscriptionStatusEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:819

hasStatusElement

hasStatusElement(): boolean
Returns boolean
true if the status property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:833

getStatus

getStatus(): null | string
Returns null | string
the status property value as a fhirCode if defined; else null

See
CodeSystem Enumeration: SubscriptionStatusEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:842

setStatus

setStatus(value: undefined | null | string): this
Assigns the provided primitive value to the status property.
Parameters
- value: undefined | null | string
  the status value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: SubscriptionStatusEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:859

hasStatus

hasStatus(): boolean
Returns boolean
true if the status property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:872

getTopicElement

getTopicElement(): CanonicalType
Returns CanonicalType
the topic property value as a CanonicalType object if defined; else an empty CanonicalType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:879

setTopicElement

setTopicElement(element: undefined | null | CanonicalType): this
Assigns the provided PrimitiveType value to the topic property.
Parameters
- element: undefined | null | CanonicalType
  the topic value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:891

hasTopicElement

hasTopicElement(): boolean
Returns boolean
true if the topic property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:905

getTopic

getTopic(): null | string
Returns null | string
the topic property value as a fhirCanonical if defined; else null
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:912

setTopic

setTopic(value: undefined | null | string): this
Assigns the provided primitive value to the topic property.
Parameters
- value: undefined | null | string
  the topic value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:927

hasTopic

hasTopic(): boolean
Returns boolean
true if the topic property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:940

getContact

getContact(): ContactPoint[]
Returns ContactPoint[]
the contact property value as a ContactPoint array
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:947

setContact

setContact(value: undefined | ContactPoint[]): this
Assigns the provided ContactPoint array value to the contact property.
Parameters
- value: undefined | ContactPoint[]
  the contact array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:958

addContact

addContact(value: undefined | ContactPoint): this
Add the provided ContactPoint value to the contact array property.
Parameters
- value: undefined | ContactPoint
  the contact value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:976

hasContact

hasContact(): boolean
Returns boolean
true if the contact property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:989

getEndElement

getEndElement(): InstantType
Returns InstantType
the end property value as a InstantType object if defined; else an empty InstantType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1005

setEndElement

setEndElement(element: undefined | InstantType): this
Assigns the provided PrimitiveType value to the end property.
Parameters
- element: undefined | InstantType
  the end value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1017

hasEndElement

hasEndElement(): boolean
Returns boolean
true if the end property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1031

getEnd

getEnd(): undefined | string
Returns undefined | string
the end property value as a fhirInstant if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1038

setEnd

setEnd(value: undefined | string): this
Assigns the provided primitive value to the end property.
Parameters
- value: undefined | string
  the end value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1049

hasEnd

hasEnd(): boolean
Returns boolean
true if the end property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1062

getManagingEntity

getManagingEntity(): Reference
Returns Reference
the managingEntity property value as a Reference object; else an empty Reference object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1069

setManagingEntity

setManagingEntity(value: undefined | Reference): this
Assigns the provided ManagingEntity object value to the managingEntity property.
Parameters
- value: undefined | Reference
  the managingEntity object value
Returns this
this

Decorator
@ReferenceTargets('Subscription.managingEntity', ['CareTeam','HealthcareService','Organization','RelatedPerson','Patient','Practitioner','PractitionerRole',])

Throws
InvalidTypeError for invalid data type or reference value
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1097

hasManagingEntity

hasManagingEntity(): boolean
Returns boolean
true if the managingEntity property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1110

getReasonElement

getReasonElement(): StringType
Returns StringType
the reason property value as a StringType object if defined; else an empty StringType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1117

setReasonElement

setReasonElement(element: undefined | StringType): this
Assigns the provided PrimitiveType value to the reason property.
Parameters
- element: undefined | StringType
  the reason value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1129

hasReasonElement

hasReasonElement(): boolean
Returns boolean
true if the reason property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1143

getReason

getReason(): undefined | string
Returns undefined | string
the reason property value as a fhirString if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1150

setReason

setReason(value: undefined | string): this
Assigns the provided primitive value to the reason property.
Parameters
- value: undefined | string
  the reason value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1161

hasReason

hasReason(): boolean
Returns boolean
true if the reason property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1174

getFilterBy

getFilterBy(): SubscriptionFilterByComponent[]
Returns SubscriptionFilterByComponent[]
the filterBy property value as a SubscriptionFilterByComponent array
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1181

setFilterBy

setFilterBy(value: undefined | SubscriptionFilterByComponent[]): this
Assigns the provided SubscriptionFilterByComponent array value to the filterBy property.
Parameters
- value: undefined | SubscriptionFilterByComponent[]
  the filterBy array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1192

addFilterBy

addFilterBy(value: undefined | SubscriptionFilterByComponent): this
Add the provided SubscriptionFilterByComponent value to the filterBy array property.
Parameters
- value: undefined | SubscriptionFilterByComponent
  the filterBy value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1210

hasFilterBy

hasFilterBy(): boolean
Returns boolean
true if the filterBy property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1223

getChannelType

getChannelType(): Coding
Returns Coding
the channelType property value as a Coding object if defined; else an empty Coding object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1239

setChannelType

setChannelType(value: undefined | null | Coding): this
Assigns the provided Coding object value to the channelType property.
Parameters
- value: undefined | null | Coding
  the channelType object value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1250

hasChannelType

hasChannelType(): boolean
Returns boolean
true if the channelType property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1264

getEndpointElement

getEndpointElement(): UrlType
Returns UrlType
the endpoint property value as a UrlType object if defined; else an empty UrlType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1271

setEndpointElement

setEndpointElement(element: undefined | UrlType): this
Assigns the provided PrimitiveType value to the endpoint property.
Parameters
- element: undefined | UrlType
  the endpoint value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1283

hasEndpointElement

hasEndpointElement(): boolean
Returns boolean
true if the endpoint property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1297

getEndpoint

getEndpoint(): undefined | string
Returns undefined | string
the endpoint property value as a fhirUrl if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1304

setEndpoint

setEndpoint(value: undefined | string): this
Assigns the provided primitive value to the endpoint property.
Parameters
- value: undefined | string
  the endpoint value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1315

hasEndpoint

hasEndpoint(): boolean
Returns boolean
true if the endpoint property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1328

getParameter

getParameter(): SubscriptionParameterComponent[]
Returns SubscriptionParameterComponent[]
the parameter property value as a SubscriptionParameterComponent array
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1335

setParameter

setParameter(value: undefined | SubscriptionParameterComponent[]): this
Assigns the provided SubscriptionParameterComponent array value to the parameter property.
Parameters
- value: undefined | SubscriptionParameterComponent[]
  the parameter array value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1346

addParameter

addParameter(value: undefined | SubscriptionParameterComponent): this
Add the provided SubscriptionParameterComponent value to the parameter array property.
Parameters
- value: undefined | SubscriptionParameterComponent
  the parameter value
Returns this
this

Throws
InvalidTypeError for invalid data types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1364

hasParameter

hasParameter(): boolean
Returns boolean
true if the parameter property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1377

getHeartbeatPeriodElement

getHeartbeatPeriodElement(): UnsignedIntType
Returns UnsignedIntType
the heartbeatPeriod property value as a UnsignedIntType object if defined; else an empty UnsignedIntType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1393

setHeartbeatPeriodElement

setHeartbeatPeriodElement(element: undefined | UnsignedIntType): this
Assigns the provided PrimitiveType value to the heartbeatPeriod property.
Parameters
- element: undefined | UnsignedIntType
  the heartbeatPeriod value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1405

hasHeartbeatPeriodElement

hasHeartbeatPeriodElement(): boolean
Returns boolean
true if the heartbeatPeriod property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1419

getHeartbeatPeriod

getHeartbeatPeriod(): undefined | number
Returns undefined | number
the heartbeatPeriod property value as a fhirUnsignedInt if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1426

setHeartbeatPeriod

setHeartbeatPeriod(value: undefined | number): this
Assigns the provided primitive value to the heartbeatPeriod property.
Parameters
- value: undefined | number
  the heartbeatPeriod value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1437

hasHeartbeatPeriod

hasHeartbeatPeriod(): boolean
Returns boolean
true if the heartbeatPeriod property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1450

getTimeoutElement

getTimeoutElement(): UnsignedIntType
Returns UnsignedIntType
the timeout property value as a UnsignedIntType object if defined; else an empty UnsignedIntType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1457

setTimeoutElement

setTimeoutElement(element: undefined | UnsignedIntType): this
Assigns the provided PrimitiveType value to the timeout property.
Parameters
- element: undefined | UnsignedIntType
  the timeout value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1469

hasTimeoutElement

hasTimeoutElement(): boolean
Returns boolean
true if the timeout property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1483

getTimeout

getTimeout(): undefined | number
Returns undefined | number
the timeout property value as a fhirUnsignedInt if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1490

setTimeout

setTimeout(value: undefined | number): this
Assigns the provided primitive value to the timeout property.
Parameters
- value: undefined | number
  the timeout value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1501

hasTimeout

hasTimeout(): boolean
Returns boolean
true if the timeout property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1514

getContentTypeElement

getContentTypeElement(): CodeType
Returns CodeType
the contentType property value as a CodeType object if defined; else an empty CodeType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1521

setContentTypeElement

setContentTypeElement(element: undefined | CodeType): this
Assigns the provided PrimitiveType value to the contentType property.
Parameters
- element: undefined | CodeType
  the contentType value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1533

hasContentTypeElement

hasContentTypeElement(): boolean
Returns boolean
true if the contentType property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1547

getContentType

getContentType(): undefined | string
Returns undefined | string
the contentType property value as a fhirCode if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1554

setContentType

setContentType(value: undefined | string): this
Assigns the provided primitive value to the contentType property.
Parameters
- value: undefined | string
  the contentType value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1565

hasContentType

hasContentType(): boolean
Returns boolean
true if the contentType property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1578

getContentEnumType

getContentEnumType(): undefined | EnumCodeType
Returns undefined | EnumCodeType
the content property value as a EnumCodeType if defined; else undefined

See
CodeSystem Enumeration: SubscriptionPayloadContentEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1587

setContentEnumType

setContentEnumType(enumType: undefined | EnumCodeType): this
Assigns the provided EnumCodeType value to the content property.
Parameters
- enumType: undefined | EnumCodeType
  the content value
Returns this
this

Throws
InvalidCodeError for invalid code values

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: SubscriptionPayloadContentEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1601

hasContentEnumType

hasContentEnumType(): boolean
Returns boolean
true if the content property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1615

getContentElement

getContentElement(): undefined | CodeType
Returns undefined | CodeType
the content property value as a CodeType if defined; else undefined

See
CodeSystem Enumeration: SubscriptionPayloadContentEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1624

setContentElement

setContentElement(element: undefined | CodeType): this
Assigns the provided PrimitiveType value to the content property.
Parameters
- element: undefined | CodeType
  the content value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
InvalidTypeError for invalid data types

See
CodeSystem Enumeration: SubscriptionPayloadContentEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1641

hasContentElement

hasContentElement(): boolean
Returns boolean
true if the content property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1655

getContent

getContent(): undefined | string
Returns undefined | string
the content property value as a fhirCode if defined; else undefined

See
CodeSystem Enumeration: SubscriptionPayloadContentEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1664

setContent

setContent(value: undefined | string): this
Assigns the provided primitive value to the content property.
Parameters
- value: undefined | string
  the content value
Returns this
this

Throws
InvalidCodeError for invalid code value

Throws
PrimitiveTypeError for invalid primitive types

See
CodeSystem Enumeration: SubscriptionPayloadContentEnum
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1681

hasContent

hasContent(): boolean
Returns boolean
true if the content property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1694

getMaxCountElement

getMaxCountElement(): PositiveIntType
Returns PositiveIntType
the maxCount property value as a PositiveIntType object if defined; else an empty PositiveIntType object
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1701

setMaxCountElement

setMaxCountElement(element: undefined | PositiveIntType): this
Assigns the provided PrimitiveType value to the maxCount property.
Parameters
- element: undefined | PositiveIntType
  the maxCount value
Returns this
this

Throws
InvalidTypeError for invalid data types

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1713

hasMaxCountElement

hasMaxCountElement(): boolean
Returns boolean
true if the maxCount property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1727

getMaxCount

getMaxCount(): undefined | number
Returns undefined | number
the maxCount property value as a fhirPositiveInt if defined; else undefined
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1734

setMaxCount

setMaxCount(value: undefined | number): this
Assigns the provided primitive value to the maxCount property.
Parameters
- value: undefined | number
  the maxCount value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1745

hasMaxCount

hasMaxCount(): boolean
Returns boolean
true if the maxCount property exists and has a value; false otherwise
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1758

fhirType

fhirType(): string
Returns string
the FHIR type defined in the FHIR standard
Implementation of IDomainResource.fhirType
Overrides DomainResource.fhirType
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1767

isEmpty

isEmpty(): boolean
Returns boolean
true if the instance is empty; false otherwise
Implementation of IDomainResource.isEmpty
Overrides DomainResource.isEmpty
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1774

isRequiredFieldsEmpty

isRequiredFieldsEmpty(): boolean
Returns boolean
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
Implementation of IDomainResource.isRequiredFieldsEmpty
Overrides DomainResource.isRequiredFieldsEmpty
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1800

copy

copy(): Subscription
Creates a copy of the current instance.

Returns Subscription
the a new instance copied from the current instance
Implementation of IDomainResource.copy
Overrides DomainResource.copy
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1811

toJSON

toJSON(): undefined | Value
Returns undefined | Value
the JSON value or undefined if the instance is empty
Implementation of IDomainResource.toJSON
Overrides DomainResource.toJSON
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1851

getText

getText(): Narrative
Returns Narrative
the text property value as a Narrative
Implementation of IDomainResource.getText
Inherited from DomainResource.getText
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:86

setText

setText(value: undefined | Narrative): this
Assigns the provided value to the text property.
Parameters
- value: undefined | Narrative
  the text value
Returns this
this
Implementation of IDomainResource.setText
Inherited from DomainResource.setText
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:93

hasText

hasText(): boolean
Returns boolean
true if the text property exists and has a value; false otherwise
Implementation of IDomainResource.hasText
Inherited from DomainResource.hasText
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:97

getContained

getContained(): IResource[]
Returns IResource[]
the contained property value as a Resource array
Implementation of IDomainResource.getContained
Inherited from DomainResource.getContained
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:101

setContained

setContained(value: undefined | IResource[]): this
Assigns the provided Resource array value to the contained property.
Parameters
- value: undefined | IResource[]
  the contained array value
Returns this
this
Implementation of IDomainResource.setContained
Inherited from DomainResource.setContained
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:108

addContained

addContained(value: undefined | IResource): this
Add the provided Resource value to the contained array property.
Parameters
- value: undefined | IResource
  the contained value
Returns this
this
Implementation of IDomainResource.addContained
Inherited from DomainResource.addContained
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:115

hasContained

hasContained(): boolean
Returns boolean
true if the contained property exists and has a value; false otherwise
Implementation of IDomainResource.hasContained
Inherited from DomainResource.hasContained
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:119

getExtension

getExtension(): IExtension[]
Returns IExtension[]
the array of extension values
Implementation of IDomainResource.getExtension
Inherited from DomainResource.getExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:127

setExtension

setExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the extension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IDomainResource.setExtension
Inherited from DomainResource.setExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:134

hasExtension

hasExtension(url?: string): boolean
Determines if the extension property exists.
Parameters
- Optionalurl: string
  the url that identifies a specific Extension
Returns boolean
true if an Extension has the provided url; false otherwise

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IDomainResource.hasExtension
Inherited from DomainResource.hasExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:146

getExtensionByUrl

getExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IDomainResource.getExtensionByUrl
Inherited from DomainResource.getExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:154

addExtension

addExtension(extension: undefined | IExtension): this
Adds the provided Extension to the extension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the extension property array
Returns this
this
Implementation of IDomainResource.addExtension
Inherited from DomainResource.addExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:161

removeExtension

removeExtension(url: string): void
Removes the Extension having the provided url from the extension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IDomainResource.removeExtension
Inherited from DomainResource.removeExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:168

getModifierExtension

getModifierExtension(): IExtension[]
Returns IExtension[]
the array of modifierExtension values
Implementation of IDomainResource.getModifierExtension
Inherited from DomainResource.getModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:182

setModifierExtension

setModifierExtension(extension: undefined | IExtension[]): this
Assigns the provided array of Extension values to the modifierExtension property.
Parameters
- extension: undefined | IExtension[]
  array of Extensions
Returns this
this
Implementation of IDomainResource.setModifierExtension
Inherited from DomainResource.setModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:189

hasModifierExtension

hasModifierExtension(url?: string): boolean
Determines if the modifierExtension property exists.
Parameters
- Optionalurl: string
  the url that identifies a specific Extension
Returns boolean
true if an Extension has the provided url

Remarks
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.

Throws
AssertionError for invalid url
Implementation of IDomainResource.hasModifierExtension
Inherited from DomainResource.hasModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:201

getModifierExtensionByUrl

getModifierExtensionByUrl(url: string): undefined | IExtension
Returns the Extension having the provided url.
Parameters
- url: string
  the url that identifies a specific Extension
Returns undefined | IExtension
the Extension having the provided url

Throws
AssertionError for invalid url
Implementation of IDomainResource.getModifierExtensionByUrl
Inherited from DomainResource.getModifierExtensionByUrl
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:209

addModifierExtension

addModifierExtension(extension: undefined | IExtension): this
Adds the provided Extension to the modifierExtension property array.
Parameters
- extension: undefined | IExtension
  the Extension value to add to the modifierExtension property array
Returns this
this
Implementation of IDomainResource.addModifierExtension
Inherited from DomainResource.addModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:216

removeModifierExtension

removeModifierExtension(url: string): void
Removes the Extension having the provided url from the modifierExtension property array.
Parameters
- url: string
  the url that identifies a specific Extension to remove
Returns void
Throws
AssertionError for invalid url
Implementation of IDomainResource.removeModifierExtension
Inherited from DomainResource.removeModifierExtension
- Defined in packages/fhir-core/lib/base-models/DomainResource.d.ts:223

resourceType

resourceType(): string
Returns string
the FHIR resource type as defined by the FHIR specification
Implementation of IDomainResource.resourceType
Inherited from DomainResource.resourceType
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:67

getIdElement

getIdElement(): IdType
Returns IdType
the id property value as a PrimitiveType
Implementation of IDomainResource.getIdElement
Inherited from DomainResource.getIdElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:127

setIdElement

setIdElement(element: undefined | IdType): this
Assigns the provided PrimitiveType value to the id property.
Parameters
- element: undefined | IdType
  the id value
Returns this
this
Implementation of IDomainResource.setIdElement
Inherited from DomainResource.setIdElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:134

hasIdElement

hasIdElement(): boolean
Returns boolean
true if the id property exists and has a value; false otherwise
Implementation of IDomainResource.hasIdElement
Inherited from DomainResource.hasIdElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:138

getId

getId(): undefined | string
Returns undefined | string
the id property value as a primitive value
Implementation of IDomainResource.getId
Inherited from DomainResource.getId
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:142

setId

setId(value: undefined | string): this
Assigns the provided primitive value to the id property.
Parameters
- value: undefined | string
  the id value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
Implementation of IDomainResource.setId
Inherited from DomainResource.setId
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:150

hasId

hasId(): boolean
Returns boolean
true if the id property exists and has a value; false otherwise
Implementation of IDomainResource.hasId
Inherited from DomainResource.hasId
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:154

getMeta

getMeta(): Meta
Returns Meta
the meta property value as a Meta
Implementation of IDomainResource.getMeta
Inherited from DomainResource.getMeta
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:158

setMeta

setMeta(value: undefined | Meta): this
Assigns the provided value to the meta property.
Parameters
- value: undefined | Meta
  the meta value
Returns this
this
Implementation of IDomainResource.setMeta
Inherited from DomainResource.setMeta
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:165

hasMeta

hasMeta(): boolean
Returns boolean
true if the meta property exists and has a value; false otherwise
Implementation of IDomainResource.hasMeta
Inherited from DomainResource.hasMeta
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:169

getImplicitRulesElement

getImplicitRulesElement(): UriType
Returns UriType
the implicitRules property value as a PrimitiveType
Implementation of IDomainResource.getImplicitRulesElement
Inherited from DomainResource.getImplicitRulesElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:173

setImplicitRulesElement

setImplicitRulesElement(element: undefined | UriType): this
Assigns the provided PrimitiveType value to the implicitRules property.
Parameters
- element: undefined | UriType
  the implicitRules value
Returns this
this
Implementation of IDomainResource.setImplicitRulesElement
Inherited from DomainResource.setImplicitRulesElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:180

hasImplicitRulesElement

hasImplicitRulesElement(): boolean
Returns boolean
true if the implicitRules property exists and has a value; false otherwise
Implementation of IDomainResource.hasImplicitRulesElement
Inherited from DomainResource.hasImplicitRulesElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:184

getImplicitRules

getImplicitRules(): undefined | string
Returns undefined | string
the implicitRules property value as a primitive value
Implementation of IDomainResource.getImplicitRules
Inherited from DomainResource.getImplicitRules
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:188

setImplicitRules

setImplicitRules(value: undefined | string): this
Assigns the provided primitive value to the implicitRules property.
Parameters
- value: undefined | string
  the implicitRules value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
Implementation of IDomainResource.setImplicitRules
Inherited from DomainResource.setImplicitRules
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:196

hasImplicitRules

hasImplicitRules(): boolean
Returns boolean
true if the system property exists and has a value; false otherwise
Implementation of IDomainResource.hasImplicitRules
Inherited from DomainResource.hasImplicitRules
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:200

getLanguageElement

getLanguageElement(): CodeType
Returns CodeType
the language property value as a PrimitiveType
Implementation of IDomainResource.getLanguageElement
Inherited from DomainResource.getLanguageElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:204

setLanguageElement

setLanguageElement(element: undefined | CodeType): this
Assigns the provided PrimitiveType value to the language property.
Parameters
- element: undefined | CodeType
  the language value
Returns this
this
Implementation of IDomainResource.setLanguageElement
Inherited from DomainResource.setLanguageElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:211

hasLanguageElement

hasLanguageElement(): boolean
Returns boolean
true if the language property exists and has a value; false otherwise
Implementation of IDomainResource.hasLanguageElement
Inherited from DomainResource.hasLanguageElement
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:215

getLanguage

getLanguage(): undefined | string
Returns undefined | string
the language property value as a primitive value
Implementation of IDomainResource.getLanguage
Inherited from DomainResource.getLanguage
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:219

setLanguage

setLanguage(value: undefined | string): this
Assigns the provided primitive value to the language property.
Parameters
- value: undefined | string
  the language value
Returns this
this

Throws
PrimitiveTypeError for invalid primitive types
Implementation of IDomainResource.setLanguage
Inherited from DomainResource.setLanguage
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:227

hasLanguage

hasLanguage(): boolean
Returns boolean
true if the language property exists and has a value; false otherwise
Implementation of IDomainResource.hasLanguage
Inherited from DomainResource.hasLanguage
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:231

isResource

isResource(): boolean
Returns boolean
true if the instance is a FHIR resource; false otherwise
Implementation of IDomainResource.isResource
Inherited from DomainResource.isResource
- Defined in packages/fhir-core/lib/base-models/Resource.d.ts:256

isDataType

isDataType(): boolean
Returns boolean
true if the instance is a FHIR complex or primitive datatype; false otherwise
Implementation of IDomainResource.isDataType
Inherited from DomainResource.isDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:71

isComplexDataType

isComplexDataType(): boolean
Returns boolean
true if the instance is a FHIR complex datatype; false otherwise
Implementation of IDomainResource.isComplexDataType
Inherited from DomainResource.isComplexDataType
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:75

isPrimitive

isPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datatype; false otherwise
Implementation of IDomainResource.isPrimitive
Inherited from DomainResource.isPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:79

isBooleanPrimitive

isBooleanPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive boolean datatype; false otherwise
Implementation of IDomainResource.isBooleanPrimitive
Inherited from DomainResource.isBooleanPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:83

isStringPrimitive

isStringPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive string-based datatype; false otherwise
Implementation of IDomainResource.isStringPrimitive
Inherited from DomainResource.isStringPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:87

isNumberPrimitive

isNumberPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive number-based datatype; false otherwise
Implementation of IDomainResource.isNumberPrimitive
Inherited from DomainResource.isNumberPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:91

isBigIntPrimitive

isBigIntPrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive bigint-based datatype; false otherwise
Implementation of IDomainResource.isBigIntPrimitive
Inherited from DomainResource.isBigIntPrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:95

isDateTimePrimitive

isDateTimePrimitive(): boolean
Returns boolean
true if the instance is a FHIR primitive datetime-based datatype; false otherwise
Implementation of IDomainResource.isDateTimePrimitive
Inherited from DomainResource.isDateTimePrimitive
- Defined in packages/fhir-core/lib/base-models/Base.d.ts:99

`Protected`copyValues

copyValues(dest: Subscription): void
Protected
Copies the current instance's elements into the provided object.
Parameters
- dest: Subscription
  the copied instance
Returns void
Overrides DomainResource.copyValues
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1823

`Private`initIdentifier

initIdentifier(): void
Initialize the identifier property

Returns void
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:690

`Private`initContact

initContact(): void
Initialize the contact property

Returns void
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:996

`Private`initFilterBy

initFilterBy(): void
Initialize the filterBy property

Returns void
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1230

`Private`initParameter

initParameter(): void
Initialize the parameter property

Returns void
- Defined in packages/r5-datamodels/src/resources/Subscription.ts:1384

Class Subscription

Remarks

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Subscription

Properties

Private Optionalidentifier

Remarks

Private Optionalname

Remarks

Private ReadonlysubscriptionStatusEnum

See

Privatestatus

Remarks

See

Privatetopic

Remarks

Private Optionalcontact

Remarks

Private Optionalend

Remarks

Private OptionalmanagingEntity

Remarks

Private Optionalreason

Remarks

Private OptionalfilterBy

Remarks

PrivatechannelType

Remarks

Private Optionalendpoint

Remarks

Private Optionalparameter

Remarks

Private OptionalheartbeatPeriod

Remarks

Private Optionaltimeout

Remarks

Private OptionalcontentType

Remarks

Private ReadonlysubscriptionPayloadContentEnum

See

Private Optionalcontent

Remarks

See

Private OptionalmaxCount

Remarks

Methods

Staticparse

Parameters

Returns undefined | Subscription

Throws

getIdentifier

Returns Identifier[]

setIdentifier

Parameters

Returns this

Throws

addIdentifier

Parameters

Returns this

Throws

hasIdentifier

Returns boolean

getNameElement

Returns StringType

setNameElement

Parameters

Returns this

Throws

Throws

hasNameElement

Returns boolean

`Private` `Optional`identifier

`Private` `Optional`name

`Private` `Readonly`subscriptionStatusEnum

`Private`status

`Private`topic

`Private` `Optional`contact

`Private` `Optional`end

`Private` `Optional`managingEntity

`Private` `Optional`reason

`Private` `Optional`filterBy

`Private`channelType

`Private` `Optional`endpoint

`Private` `Optional`parameter

`Private` `Optional`heartbeatPeriod

`Private` `Optional`timeout

`Private` `Optional`contentType

`Private` `Readonly`subscriptionPayloadContentEnum

`Private` `Optional`content

`Private` `Optional`maxCount

`Static`parse