Private ReadonlysubscriptionFHIR CodeSystem: SubscriptionStatus
PrivatestatusSubscription.status Element
FHIR Specification
codeCodeSystem Enumeration: SubscriptionStatusEnum
Private OptionalcontactSubscription.contact Element
Private OptionalendSubscription.end Element
PrivatereasonSubscription.reason Element
PrivatecriteriaSubscription.criteria Element
FHIR Specification
stringPrivate OptionalerrorSubscription.error Element
PrivatechannelSubscription.channel Element
StaticparseParse the provided Subscription JSON to instantiate the Subscription data model.
JSON representing FHIR Subscription
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to Subscription
Subscription data model or undefined for Subscription
JsonError if the provided JSON is not a valid JSON object
the status property value as a EnumCodeType if defined; else null
CodeSystem Enumeration: SubscriptionStatusEnum
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: SubscriptionStatusEnum
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: SubscriptionStatusEnum
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: SubscriptionStatusEnum
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: SubscriptionStatusEnum
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: SubscriptionStatusEnum
true if the status property exists and has a value; false otherwise
the contact property value as a ContactPoint array
Assigns the provided ContactPoint array value to the contact property.
the contact array value
this
InvalidTypeError for invalid data types
Add the provided ContactPoint 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 end property value as a InstantType object if defined; else an empty InstantType object
Assigns the provided PrimitiveType value to the end property.
the end value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the end property exists and has a value; false otherwise
the end property value as a fhirInstant if defined; else undefined
Assigns the provided primitive value to the end property.
the end value
this
PrimitiveTypeError for invalid primitive types
true if the end property exists and has a value; false otherwise
the reason property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the reason property.
the reason value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the reason property exists and has a value; false otherwise
the reason property value as a fhirString if defined; else null
Assigns the provided primitive value to the reason property.
the reason value
this
PrimitiveTypeError for invalid primitive types
true if the reason property exists and has a value; false otherwise
the criteria property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the criteria property.
the criteria value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the criteria property exists and has a value; false otherwise
the criteria property value as a fhirString if defined; else null
Assigns the provided primitive value to the criteria property.
the criteria value
this
PrimitiveTypeError for invalid primitive types
true if the criteria property exists and has a value; false otherwise
the error property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the error property.
the error value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the error property exists and has a value; false otherwise
the error property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the error property.
the error value
this
PrimitiveTypeError for invalid primitive types
true if the error property exists and has a value; false otherwise
the channel property value as a SubscriptionChannelComponent object if defined; else an empty SubscriptionChannelComponent object
Assigns the provided SubscriptionChannelComponent object value to the channel property.
the channel object value
this
InvalidTypeError for invalid data types
true if the channel 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
Subscription Class
Remarks
The subscription resource is used to define a push-based subscription from a server to another system. Once a subscription is registered with the server, the server checks every resource that is created or updated, and if the resource matches the given criteria, it sends a message on the defined "channel" so that another system can take an appropriate action.
FHIR Specification
See
FHIR Subscription