Private OptionalurlMessageDefinition.url Element
FHIR Specification
uriPrivate OptionalidentifierMessageDefinition.identifier Element
FHIR Specification
IdentifierPrivate OptionalversionMessageDefinition.version Element
FHIR Specification
stringPrivate OptionalversionMessageDefinition.versionAlgorithm[x] Element
FHIR Specification
Private OptionalnameMessageDefinition.name Element
FHIR Specification
stringPrivate OptionaltitleMessageDefinition.title Element
FHIR Specification
stringPrivate OptionalreplacesMessageDefinition.replaces Element
FHIR Specification
canonical
Private ReadonlypublicationFHIR CodeSystem: PublicationStatus
PrivatestatusMessageDefinition.status Element
FHIR Specification
codeCodeSystem Enumeration: PublicationStatusEnum
Private OptionalexperimentalMessageDefinition.experimental Element
FHIR Specification
booleanPrivatedateMessageDefinition.date Element
FHIR Specification
dateTimePrivate OptionalpublisherMessageDefinition.publisher Element
FHIR Specification
stringPrivate OptionalcontactMessageDefinition.contact Element
FHIR Specification
ContactDetailPrivate OptionaldescriptionMessageDefinition.description Element
FHIR Specification
markdownPrivate OptionaluseMessageDefinition.useContext Element
FHIR Specification
UsageContextPrivate OptionaljurisdictionMessageDefinition.jurisdiction Element
FHIR Specification
CodeableConceptPrivate OptionalpurposeMessageDefinition.purpose Element
FHIR Specification
markdownPrivate OptionalcopyrightMessageDefinition.copyright Element
FHIR Specification
markdownPrivate OptionalcopyrightMessageDefinition.copyrightLabel Element
FHIR Specification
stringPrivate OptionalbaseMessageDefinition.base Element
FHIR Specification
canonical
Private OptionalparentMessageDefinition.parent Element
FHIR Specification
canonical
PrivateeventMessageDefinition.event[x] Element
Private ReadonlymessageFHIR CodeSystem: MessageSignificanceCategory
Private OptionalcategoryMessageDefinition.category Element
FHIR Specification
codeCodeSystem Enumeration: MessageSignificanceCategoryEnum
Private OptionalfocusMessageDefinition.focus Element
FHIR Specification
BackboneElementPrivate ReadonlymessageheaderFHIR CodeSystem: MessageheaderResponseRequest
Private OptionalresponseMessageDefinition.responseRequired Element
FHIR Specification
codeCodeSystem Enumeration: MessageheaderResponseRequestEnum
Private OptionalallowedMessageDefinition.allowedResponse Element
FHIR Specification
BackboneElementPrivate OptionalgraphMessageDefinition.graph Element
FHIR Specification
canonical
StaticparseParse the provided MessageDefinition JSON to instantiate the MessageDefinition data model.
JSON representing FHIR MessageDefinition
OptionaloptSourceField: stringOptional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MessageDefinition
MessageDefinition data model or undefined for MessageDefinition
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 identifier property value as a Identifier array
Assigns the provided Identifier array value to the identifier property.
the identifier array value
this
InvalidTypeError for invalid data types
Add the provided Identifier value to the identifier array property.
the identifier value
this
InvalidTypeError for invalid data types
true if the identifier 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 versionAlgorithm property value as a DataType object if defined; else undefined
Assigns the provided DataType object value to the versionAlgorithm property.
the versionAlgorithm object value
this
InvalidTypeError for invalid data types
true if the versionAlgorithm property exists and has a value; false otherwise
the versionAlgorithm property value as a StringType object if defined; else undefined
true if the versionAlgorithm property exists as a StringType and has a value; false otherwise
the versionAlgorithm property value as a Coding object if defined; else undefined
true if the versionAlgorithm property exists as a Coding 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 replaces property value as a CanonicalType array
Assigns the provided CanonicalType array value to the replaces property.
the replaces array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the replaces array property.
the replaces value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the replaces property exists and has a value; false otherwise
the replaces property value as a fhirCanonical array
Assigns the provided primitive value array to the replaces property.
the replaces value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the replaces array property.
the replaces value
this
PrimitiveTypeError for invalid primitive types
true if the replaces 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 copyrightLabel property value as a StringType object if defined; else an empty StringType object
Assigns the provided PrimitiveType value to the copyrightLabel property.
the copyrightLabel value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the copyrightLabel property exists and has a value; false otherwise
the copyrightLabel property value as a fhirString if defined; else undefined
Assigns the provided primitive value to the copyrightLabel property.
the copyrightLabel value
this
PrimitiveTypeError for invalid primitive types
true if the copyrightLabel property exists and has a value; false otherwise
the base property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the base property.
the base value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the base property exists and has a value; false otherwise
the base property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the base property.
the base value
this
PrimitiveTypeError for invalid primitive types
true if the base property exists and has a value; false otherwise
the parent property value as a CanonicalType array
Assigns the provided CanonicalType array value to the parent property.
the parent array value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
Add the provided CanonicalType value to the parent array property.
the parent value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the parent property exists and has a value; false otherwise
the parent property value as a fhirCanonical array
Assigns the provided primitive value array to the parent property.
the parent value array
this
PrimitiveTypeError for invalid primitive types
Add the provided primitive value to the parent array property.
the parent value
this
PrimitiveTypeError for invalid primitive types
true if the parent property exists and has a value; false otherwise
the event property value as a DataType object; else null
Assigns the provided DataType object value to the event property.
the event object value
this
InvalidTypeError for invalid data types
true if the event property exists and has a value; false otherwise
the event property value as a Coding object if defined; else null
true if the `` property exists as a Coding and has a value; false otherwise
the event property value as a UriType object if defined; else null
true if the `` property exists as a UriType and has a value; false otherwise
the category property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: MessageSignificanceCategoryEnum
Assigns the provided EnumCodeType value to the category property.
the category value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: MessageSignificanceCategoryEnum
true if the category property exists and has a value; false otherwise
the category property value as a CodeType if defined; else undefined
CodeSystem Enumeration: MessageSignificanceCategoryEnum
Assigns the provided PrimitiveType value to the category property.
the category value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: MessageSignificanceCategoryEnum
true if the category property exists and has a value; false otherwise
the category property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: MessageSignificanceCategoryEnum
Assigns the provided primitive value to the category property.
the category value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: MessageSignificanceCategoryEnum
true if the category property exists and has a value; false otherwise
the focus property value as a MessageDefinitionFocusComponent array
Assigns the provided MessageDefinitionFocusComponent array value to the focus property.
the focus array value
this
InvalidTypeError for invalid data types
Add the provided MessageDefinitionFocusComponent value to the focus array property.
the focus value
this
InvalidTypeError for invalid data types
true if the focus property exists and has a value; false otherwise
the responseRequired property value as a EnumCodeType if defined; else undefined
CodeSystem Enumeration: MessageheaderResponseRequestEnum
Assigns the provided EnumCodeType value to the responseRequired property.
the responseRequired value
this
InvalidCodeError for invalid code values
InvalidTypeError for invalid data types
CodeSystem Enumeration: MessageheaderResponseRequestEnum
true if the responseRequired property exists and has a value; false otherwise
the responseRequired property value as a CodeType if defined; else undefined
CodeSystem Enumeration: MessageheaderResponseRequestEnum
Assigns the provided PrimitiveType value to the responseRequired property.
the responseRequired value
this
InvalidCodeError for invalid code value
InvalidTypeError for invalid data types
CodeSystem Enumeration: MessageheaderResponseRequestEnum
true if the responseRequired property exists and has a value; false otherwise
the responseRequired property value as a fhirCode if defined; else undefined
CodeSystem Enumeration: MessageheaderResponseRequestEnum
Assigns the provided primitive value to the responseRequired property.
the responseRequired value
this
InvalidCodeError for invalid code value
PrimitiveTypeError for invalid primitive types
CodeSystem Enumeration: MessageheaderResponseRequestEnum
true if the responseRequired property exists and has a value; false otherwise
the allowedResponse property value as a MessageDefinitionAllowedResponseComponent array
Assigns the provided MessageDefinitionAllowedResponseComponent array value to the allowedResponse property.
the allowedResponse array value
this
InvalidTypeError for invalid data types
Add the provided MessageDefinitionAllowedResponseComponent value to the allowedResponse array property.
the allowedResponse value
this
InvalidTypeError for invalid data types
true if the allowedResponse property exists and has a value; false otherwise
the graph property value as a CanonicalType object if defined; else an empty CanonicalType object
Assigns the provided PrimitiveType value to the graph property.
the graph value
this
InvalidTypeError for invalid data types
PrimitiveTypeError for invalid primitive types
true if the graph property exists and has a value; false otherwise
the graph property value as a fhirCanonical if defined; else undefined
Assigns the provided primitive value to the graph property.
the graph value
this
PrimitiveTypeError for invalid primitive types
true if the graph 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 identifier property
PrivateinitInitialize the replaces property
PrivateinitInitialize the contact property
PrivateinitInitialize the useContext property
PrivateinitInitialize the jurisdiction property
PrivateinitInitialize the parent property
PrivateinitInitialize the focus property
PrivateinitInitialize the allowedResponse property
MessageDefinition Class
Remarks
Defines the characteristics of a message that can be shared between systems, including the type of event that initiates the message, the content to be transmitted and what response(s), if any, are permitted.
Allows messages to be defined once and re-used across systems.
FHIR Specification
See
FHIR MessageDefinition