Data Model Libraries
    Preparing search index...

    Class MessageHeader

    MessageHeader Class

    The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.

    Many implementations are not prepared to use REST and need a messaging based infrastructure.

    FHIR Specification

    • Short: A resource that describes a message that is exchanged between systems
    • Definition: The header for a message exchange that is either requesting or responding to an action. The reference(s) that are the subject of the action as well as other information related to the action are typically transmitted in a bundle in which the MessageHeader resource instance is the first resource in the bundle.
    • FHIR Version: 4.0.1

    FHIR MessageHeader

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties

    event destination? sender? enterer? author? source responsible? reason? response? focus? definition?

    Methods

    parse getEvent setEvent hasEvent getEventCoding hasEventCoding getEventUriType hasEventUriType getDestination setDestination addDestination hasDestination getSender setSender hasSender getEnterer setEnterer hasEnterer getAuthor setAuthor hasAuthor getSource setSource hasSource getResponsible setResponsible hasResponsible getReason setReason hasReason getResponse setResponse hasResponse getFocus setFocus addFocus hasFocus getDefinitionElement setDefinitionElement hasDefinitionElement getDefinition setDefinition hasDefinition 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 initDestination initFocus

    Constructors

    Properties

    event: null | IDataType

    MessageHeader.event[x] Element

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

    FHIR Specification

    • Short: Code for the event this message represents or link to event definition
    • Definition: Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.
    • Comment: The time of the event will be found in the focus resource. The time of the message will be found in Bundle.timestamp.
    • Requirements: Drives the behavior associated with this message.
    • FHIR Types: 'Coding', 'uri',
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    destination?: MessageHeaderDestinationComponent[]

    MessageHeader.destination Element

    FHIR Specification

    • Short: Message destination application(s)
    • Definition: The destination application which the message is intended for.
    • Comment: There SHOULD be at least one destination, but in some circumstances, the source system is unaware of any particular destination system.
    • Requirements: Indicates where message is to be sent for routing purposes. Allows verification of "am I the intended recipient".
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    sender?: Reference

    MessageHeader.sender Element

    FHIR Specification

    enterer?: Reference

    MessageHeader.enterer Element

    FHIR Specification

    • Short: The source of the data entry
    • Definition: The person or device that performed the data entry leading to this message. When there is more than one candidate, pick the most proximal to the message. Can provide other enterers in extensions.
    • Comment: Usually only for the request but can be used in a response.
    • Requirements: Need to know for audit/traceback requirements and possibly for authorization.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    author?: Reference

    MessageHeader.author Element

    FHIR Specification

    • Short: The source of the decision
    • Definition: The logical author of the message - the person or device that decided the described event should happen. When there is more than one candidate, pick the most proximal to the MessageHeader. Can provide other authors in extensions.
    • Comment: Usually only for the request but can be used in a response.
    • Requirements: Need to know for audit/traceback requirements and possibly for authorization.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    source: null | MessageHeaderSourceComponent

    MessageHeader.source Element

    FHIR Specification

    • Short: Message source application
    • Definition: The source application from which this message originated.
    • Requirements: Allows replies, supports audit.
    • FHIR Type: BackboneElement
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    responsible?: Reference

    MessageHeader.responsible Element

    FHIR Specification

    reason?: CodeableConcept

    MessageHeader.reason Element

    FHIR Specification

    • Short: Cause of event
    • Definition: Coded indication of the cause for the event - indicates a reason for the occurrence of the event that is a focus of this message.
    • Requirements: Need to be able to track why resources are being changed and report in the audit log/history of the resource. May affect authorization.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    response?: MessageHeaderResponseComponent

    MessageHeader.response Element

    FHIR Specification

    • Short: If this is a reply to prior message
    • Definition: Information about the message that this message is a response to. Only present if this message is a response.
    • FHIR Type: BackboneElement
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    focus?: Reference[]

    MessageHeader.focus Element

    FHIR Specification

    • Short: The actual content of the message
    • Definition: The actual data of the message - a reference to the root/focus class of the event.
    • Comment: The data is defined where the transaction type is defined. The transaction data is always included in the bundle that is the full message. Only the root resource is specified. The resources it references should be contained in the bundle but are not also listed here. Multiple repetitions are allowed to cater for merges and other situations with multiple focal targets.
    • Requirements: Every message event is about actual data, a single resource, that is identified in the definition of the event, and perhaps some or all linked resources.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    definition?: CanonicalType

    MessageHeader.definition Element

    FHIR Specification

    • Short: Link to the definition for this message
    • Definition: Permanent link to the MessageDefinition for this message.
    • Requirements: Allows sender to define the expected contents of the message.
    • FHIR Type: canonical
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MessageHeader

      • OptionaloptSourceField: string

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

      Returns undefined | MessageHeader

      MessageHeader data model or undefined for MessageHeader

      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
    parsegetEventsetEventhasEventgetEventCodinghasEventCodinggetEventUriTypehasEventUriTypegetDestinationsetDestinationaddDestinationhasDestinationgetSendersetSenderhasSendergetEnterersetEntererhasEnterergetAuthorsetAuthorhasAuthorgetSourcesetSourcehasSourcegetResponsiblesetResponsiblehasResponsiblegetReasonsetReasonhasReasongetResponsesetResponsehasResponsegetFocussetFocusaddFocushasFocusgetDefinitionElementsetDefinitionElementhasDefinitionElementgetDefinitionsetDefinitionhasDefinitionfhirTypeisEmptyisRequiredFieldsEmptycopytoJSONgetTextsetTexthasTextgetContainedsetContainedaddContainedhasContainedgetExtensionsetExtensionhasExtensiongetExtensionByUrladdExtensionremoveExtensiongetModifierExtensionsetModifierExtensionhasModifierExtensiongetModifierExtensionByUrladdModifierExtensionremoveModifierExtensionresourceTypegetIdElementsetIdElementhasIdElementgetIdsetIdhasIdgetMetasetMetahasMetagetImplicitRulesElementsetImplicitRulesElementhasImplicitRulesElementgetImplicitRulessetImplicitRuleshasImplicitRulesgetLanguageElementsetLanguageElementhasLanguageElementgetLanguagesetLanguagehasLanguageisResourceisDataTypeisComplexDataTypeisPrimitiveisBooleanPrimitiveisStringPrimitiveisNumberPrimitiveisBigIntPrimitiveisDateTimePrimitivecopyValuesinitDestinationinitFocus