Data Model Libraries
    Preparing search index...

    Class MessageDefinition

    MessageDefinition Class

    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

    • Short: A resource that defines a type of message that can be exchanged between systems
    • Definition: 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.
    • Comment: This would be a MIF-level artifact.
    • FHIR Version: 4.0.1

    FHIR MessageDefinition

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    url? identifier? version? name? title? replaces? publicationStatusEnum status experimental? date publisher? contact? description? useContext? jurisdiction? purpose? copyright? base? parent? event messageSignificanceCategoryEnum category? focus? messageheaderResponseRequestEnum responseRequired? allowedResponse? graph?

    Methods

    parse getUrlElement setUrlElement hasUrlElement getUrl setUrl hasUrl getIdentifier setIdentifier addIdentifier hasIdentifier getVersionElement setVersionElement hasVersionElement getVersion setVersion hasVersion getNameElement setNameElement hasNameElement getName setName hasName getTitleElement setTitleElement hasTitleElement getTitle setTitle hasTitle getReplacesElement setReplacesElement addReplacesElement hasReplacesElement getReplaces setReplaces addReplaces hasReplaces getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getExperimentalElement setExperimentalElement hasExperimentalElement getExperimental setExperimental hasExperimental getDateElement setDateElement hasDateElement getDate setDate hasDate getPublisherElement setPublisherElement hasPublisherElement getPublisher setPublisher hasPublisher getContact setContact addContact hasContact getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getUseContext setUseContext addUseContext hasUseContext getJurisdiction setJurisdiction addJurisdiction hasJurisdiction getPurposeElement setPurposeElement hasPurposeElement getPurpose setPurpose hasPurpose getCopyrightElement setCopyrightElement hasCopyrightElement getCopyright setCopyright hasCopyright getBaseElement setBaseElement hasBaseElement getBase setBase hasBase getParentElement setParentElement addParentElement hasParentElement getParent setParent addParent hasParent getEvent setEvent hasEvent getEventCoding hasEventCoding getEventUriType hasEventUriType getCategoryEnumType setCategoryEnumType hasCategoryEnumType getCategoryElement setCategoryElement hasCategoryElement getCategory setCategory hasCategory getFocus setFocus addFocus hasFocus getResponseRequiredEnumType setResponseRequiredEnumType hasResponseRequiredEnumType getResponseRequiredElement setResponseRequiredElement hasResponseRequiredElement getResponseRequired setResponseRequired hasResponseRequired getAllowedResponse setAllowedResponse addAllowedResponse hasAllowedResponse getGraphElement setGraphElement addGraphElement hasGraphElement getGraph setGraph addGraph hasGraph 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 initReplaces initContact initUseContext initJurisdiction initParent initFocus initAllowedResponse initGraph

    Constructors

    Properties

    url?: UriType

    MessageDefinition.url Element

    FHIR Specification

    • Short: Business Identifier for a given MessageDefinition
    • Definition: The business identifier that is used to reference the MessageDefinition and is expected to be consistent from server to server.
    • Comment: Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions. In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.
    • Requirements: Allows the message definition to be referenced by a single globally unique identifier.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    identifier?: Identifier[]

    MessageDefinition.identifier Element

    FHIR Specification

    • Short: Primary key for the message definition on a given server
    • Definition: A formal identifier that is used to identify this message definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
    • Comment: Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this message definition outside of FHIR, where it is not possible to use the logical URI.
    • Requirements: Allows externally provided and/or usable business identifiers to be easily associated with the module.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    version?: StringType

    MessageDefinition.version Element

    FHIR Specification

    • Short: Business version of the message definition
    • Definition: The identifier that is used to identify this version of the message definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the message definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.
    • Comment: There may be different message definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the message definition with the format [url]|[version].
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    name?: StringType

    MessageDefinition.name Element

    FHIR Specification

    • Short: Name for this message definition (computer friendly)
    • Definition: A natural language name identifying the message definition. This name should be usable as an identifier for the module by machine processing applications such as code generation.
    • Comment: The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.
    • Requirements: Support human navigation and code generation.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    title?: StringType

    MessageDefinition.title Element

    FHIR Specification

    • Short: Name for this message definition (human friendly)
    • Definition: A short, descriptive, user-friendly title for the message definition.
    • Comment: This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    replaces?: CanonicalType[]

    MessageDefinition.replaces Element

    FHIR Specification

    publicationStatusEnum: PublicationStatusEnum

    FHIR CodeSystem: PublicationStatus

    PublicationStatusEnum

    status: null | EnumCodeType

    MessageDefinition.status Element

    FHIR Specification

    • Short: draft | active | retired | unknown
    • Definition: The status of this message definition. Enables tracking the life-cycle of the content.
    • Comment: Allows filtering of message definitions that are appropriate for use versus not.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    • isSummary: true

    CodeSystem Enumeration: PublicationStatusEnum

    experimental?: BooleanType

    MessageDefinition.experimental Element

    FHIR Specification

    • Short: For testing purposes, not real usage
    • Definition: A Boolean value to indicate that this message definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
    • Comment: Allows filtering of message definitions that are appropriate for use versus not.
    • Requirements: Enables experimental content to be developed following the same lifecycle that would be used for a production-level message definition.
    • FHIR Type: boolean
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    date: null | DateTimeType

    MessageDefinition.date Element

    FHIR Specification

    • Short: Date last changed
    • Definition: The date (and optionally time) when the message definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the message definition changes.
    • Comment: Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the message definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.
    • FHIR Type: dateTime
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    publisher?: StringType

    MessageDefinition.publisher Element

    FHIR Specification

    • Short: Name of the publisher (organization or individual)
    • Definition: The name of the organization or individual that published the message definition.
    • Comment: Usually an organization but may be an individual. The publisher (or steward) of the message definition is the organization or individual primarily responsible for the maintenance and upkeep of the message definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the message definition. This item SHOULD be populated unless the information is available from context.
    • Requirements: Helps establish the "authority/credibility" of the message definition. May also allow for contact.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    contact?: ContactDetail[]

    MessageDefinition.contact Element

    FHIR Specification

    • Short: Contact details for the publisher
    • Definition: Contact details to assist a user in finding and communicating with the publisher.
    • Comment: May be a web site, an email address, a telephone number, etc.
    • FHIR Type: ContactDetail
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    description?: MarkdownType

    MessageDefinition.description Element

    FHIR Specification

    • Short: Natural language description of the message definition
    • Definition: A free text natural language description of the message definition from a consumer's perspective.
    • Comment: This description can be used to capture details such as why the message definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the message definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the message definition is presumed to be the predominant language in the place the message definition was created).
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    useContext?: UsageContext[]

    MessageDefinition.useContext Element

    FHIR Specification

    • Short: The context that the content is intended to support
    • Definition: The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate message definition instances.
    • Comment: When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.
    • Requirements: Assist in searching for appropriate content.
    • FHIR Type: UsageContext
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    jurisdiction?: CodeableConcept[]

    MessageDefinition.jurisdiction Element

    FHIR Specification

    • Short: Intended jurisdiction for message definition (if applicable)
    • Definition: A legal or geographic region in which the message definition is intended to be used.
    • Comment: It may be possible for the message definition to be used in jurisdictions other than those for which it was originally designed or intended.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    purpose?: MarkdownType

    MessageDefinition.purpose Element

    FHIR Specification

    • Short: Why this message definition is defined
    • Definition: Explanation of why this message definition is needed and why it has been designed as it has.
    • Comment: This element does not describe the usage of the message definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this message definition.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    copyright?: MarkdownType

    MessageDefinition.copyright Element

    FHIR Specification

    • Short: Use and/or publishing restrictions
    • Definition: A copyright statement relating to the message definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the message definition.
    • Requirements: Consumers must be able to determine any legal restrictions on the use of the message definition and/or its content.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    base?: CanonicalType

    MessageDefinition.base Element

    FHIR Specification

    parent?: CanonicalType[]

    MessageDefinition.parent Element

    FHIR Specification

    event: null | IDataType

    MessageDefinition.event[x] Element

    @ChoiceDataTypesMeta('MessageDefinition.event[x]', ['Coding','uri',]

    FHIR Specification

    • Short: Event code or link to the EventDefinition
    • Definition: Event code or link to the EventDefinition.
    • FHIR Types: 'Coding', 'uri',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    messageSignificanceCategoryEnum: MessageSignificanceCategoryEnum

    FHIR CodeSystem: MessageSignificanceCategory

    MessageSignificanceCategoryEnum

    category?: EnumCodeType

    MessageDefinition.category Element

    FHIR Specification

    • Short: consequence | currency | notification
    • Definition: The impact of the content of the message.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: MessageSignificanceCategoryEnum

    focus?: MessageDefinitionFocusComponent[]

    MessageDefinition.focus Element

    FHIR Specification

    • Short: Resource(s) that are the subject of the event
    • Definition: Identifies the resource (or resources) that are being addressed by the event. For example, the Encounter for an admit message or two Account records for a merge.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    messageheaderResponseRequestEnum: MessageheaderResponseRequestEnum

    FHIR CodeSystem: MessageheaderResponseRequest

    MessageheaderResponseRequestEnum

    responseRequired?: EnumCodeType

    MessageDefinition.responseRequired Element

    FHIR Specification

    • Short: always | on-error | never | on-success
    • Definition: Declare at a message definition level whether a response is required or only upon error or success, or never.
    • Comment: This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message instance level whether a response is required or only upon error or success, or never.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: MessageheaderResponseRequestEnum

    allowedResponse?: MessageDefinitionAllowedResponseComponent[]

    MessageDefinition.allowedResponse Element

    FHIR Specification

    • Short: Responses to this message
    • Definition: Indicates what types of messages may be sent as an application-level response to this message.
    • Comment: This indicates an application level response to "close" a transaction implicit in a particular request message. To define a complete workflow scenario, look to the [[PlanDefinition]] resource which allows the definition of complex orchestrations, conditionality, etc.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    graph?: CanonicalType[]

    MessageDefinition.graph Element

    FHIR Specification

    • Short: Canonical reference to a GraphDefinition
    • Definition: Canonical reference to a GraphDefinition. If a URL is provided, it is the canonical reference to a GraphDefinition that it controls what resources are to be added to the bundle when building the document. The GraphDefinition can also specify profiles that apply to the various resources.
    • FHIR Type: canonical
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

    • Parse the provided MessageDefinition JSON to instantiate the MessageDefinition data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR MessageDefinition

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MessageDefinition

      Returns undefined | MessageDefinition

      MessageDefinition data model or undefined for MessageDefinition

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • 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

      AssertionError for invalid url

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    parsegetUrlElementsetUrlElementhasUrlElementgetUrlsetUrlhasUrlgetIdentifiersetIdentifieraddIdentifierhasIdentifiergetVersionElementsetVersionElementhasVersionElementgetVersionsetVersionhasVersiongetNameElementsetNameElementhasNameElementgetNamesetNamehasNamegetTitleElementsetTitleElementhasTitleElementgetTitlesetTitlehasTitlegetReplacesElementsetReplacesElementaddReplacesElementhasReplacesElementgetReplacessetReplacesaddReplaceshasReplacesgetStatusEnumTypesetStatusEnumTypehasStatusEnumTypegetStatusElementsetStatusElementhasStatusElementgetStatussetStatushasStatusgetExperimentalElementsetExperimentalElementhasExperimentalElementgetExperimentalsetExperimentalhasExperimentalgetDateElementsetDateElementhasDateElementgetDatesetDatehasDategetPublisherElementsetPublisherElementhasPublisherElementgetPublishersetPublisherhasPublishergetContactsetContactaddContacthasContactgetDescriptionElementsetDescriptionElementhasDescriptionElementgetDescriptionsetDescriptionhasDescriptiongetUseContextsetUseContextaddUseContexthasUseContextgetJurisdictionsetJurisdictionaddJurisdictionhasJurisdictiongetPurposeElementsetPurposeElementhasPurposeElementgetPurposesetPurposehasPurposegetCopyrightElementsetCopyrightElementhasCopyrightElementgetCopyrightsetCopyrighthasCopyrightgetBaseElementsetBaseElementhasBaseElementgetBasesetBasehasBasegetParentElementsetParentElementaddParentElementhasParentElementgetParentsetParentaddParenthasParentgetEventsetEventhasEventgetEventCodinghasEventCodinggetEventUriTypehasEventUriTypegetCategoryEnumTypesetCategoryEnumTypehasCategoryEnumTypegetCategoryElementsetCategoryElementhasCategoryElementgetCategorysetCategoryhasCategorygetFocussetFocusaddFocushasFocusgetResponseRequiredEnumTypesetResponseRequiredEnumTypehasResponseRequiredEnumTypegetResponseRequiredElementsetResponseRequiredElementhasResponseRequiredElementgetResponseRequiredsetResponseRequiredhasResponseRequiredgetAllowedResponsesetAllowedResponseaddAllowedResponsehasAllowedResponsegetGraphElementsetGraphElementaddGraphElementhasGraphElementgetGraphsetGraphaddGraphhasGraphfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitIdentifierinitReplacesinitContactinitUseContextinitJurisdictioninitParentinitFocusinitAllowedResponseinitGraph