ITK FHIR Distribution

ITK-MessageHeader-1

The 'ITK-MessageHeader-1' is the header for the ITK FHIR Bundle message exchange that is responding to an action.

The reference(s) that is the subject of the action as well as other information related to the action are transmitted in the 'ITK-Bundle-1' bundle, in which the MessageHeader resource instance is the first resource in the bundle.

The actual content of the data resource is specified for each message event and the actual content of the message is referenced from the MessageHeader.data element.

Any resources referenced in the MessageHeader.data element are always included in the bundle.

NameCard.TypeDescription & Constraints
..MessageHeaderMessageHeaderA resource that describes a message that is exchanged between systems

...id0..1IdLogical id of this artifact

...meta0..1MetaMetadata about the resource

...implicitRules0..1UriA set of rules under which this content was created

...language0..1CodeLanguage of the resource content
Binding A human language. (http://tools.ietf.org/html/bcp47)
Binding Strength Required

...text0..1NarrativeText summary of the resource, for human interpretation

...contained0..*ResourceContained, inline Resources

...ITKMessageHandling1..*ExtensionComplex extension for message handling specification.
Extension https://fhir.nhs.uk/StructureDefinition/extension-itk-messagehandling-1

...senderReference0..1ExtensionLocal reference value
Extension https://fhir.nhs.uk/StructureDefinition/extension-senderreference-1

...timestamp1..1InstantTime that the message was sent

...eventCode for the event this message represents
Slice: Ordering: Ordered, Discriminator: system, Rules: Closed
Binding One of the message events defined as part of FHIR. (http://hl7.org/fhir/ValueSet/message-events)
Binding Strength Preferred

...event (Document)0..1CodingCode for the event this message represents
Binding Type of document (https://fhir.nhs.uk/ValueSet/document-type-1)
Binding Strength Required

....id0..1Idxml:id (or equivalent in JSON)

....CareSettingType1..1ExtensionCare Setting Type
Extension https://fhir.nhs.uk/StructureDefinition/extension-cofe-care-setting-type-1

....system1..1UriIdentity of the terminology system
Fixed Value https://fhir.nhs.uk/ValueSet/document-type-1

....code1..1CodeSymbol in syntax defined by the system
Binding A set of codes to classify the type of document. (https://fhir.nhs.uk/ValueSet/document-type-1)
Binding Strength Preferred
Example Value 308292007

....display1..1StringRepresentation defined by the system
Example Value Transfer of care

...event (Message)0..1CodingCode for the event this message represents
Binding One of the message events defined as part of FHIR. (http://hl7.org/fhir/ValueSet/message-events)
Binding Strength Preferred

....id0..1Idxml:id (or equivalent in JSON)

....system1..1UriIdentity of the alternative system

....version0..1StringVersion of the system - if relevant

....code1..1CodeSymbol in syntax defined by the system
Example Value admin-notify

....display1..1StringRepresentation defined by the system
Example Value admin-notify

...response0..1BackboneElementIf this is a reply to prior message

....id0..1Idxml:id (or equivalent in JSON)

....identifier1..1IdId of original message
Example Value 5369005e-7d37-414e-b81d-034d11b2e56f

....code1..1Codeok | transient-error | fatal-error
Binding The kind of response to a message (http://hl7.org/fhir/ValueSet/response-code)
Binding Strength Required
Example Value ok

....details0..1Reference (OperationOutcome)Specific list of hints/warnings/errors. If this is used for an ITK business acknoweldgement, the URI is https://fhir.nhs.uk/StructureDefinition/itk-businessack-operationoutcome-1.

.....id0..1Idxml:id (or equivalent in JSON)

...source1..1BackboneElementMessage Source Application

....id0..1Idxml:id (or equivalent in JSON)

....name0..1StringName of system

....software0..1StringName of software running the system

....version0..1StringVersion of software running

....contact0..1ContactPointHuman contact for problems

.....id0..1Idxml:id (or equivalent in JSON)

.....system0..1Codephone | fax | email | pager | other
Binding Telecommunications form for contact point (http://hl7.org/fhir/ValueSet/contact-point-system)
Binding Strength Required

.....value0..1StringThe actual contact point details

.....use0..1Codehome | work | temp | old | mobile - purpose of this contact point
Binding Use of contact point (http://hl7.org/fhir/ValueSet/contact-point-use)
Binding Strength Required

.....rank0..1PositiveIntSpecify preferred order of use (1 = highest)

.....period0..1PeriodTime period when the contact point was/is in use

......id0..1Idxml:id (or equivalent in JSON)

......start0..1DateTimeStarting time with inclusive boundary

......end0..1DateTimeEnd time with inclusive boundary, if not ongoing

....endpoint1..1UriActual message source address or id
Example Value urn:nhs-uk:addressing:ods:B83019

...destination0..*BackboneElementMessage Destination Application(s)

....id0..1Idxml:id (or equivalent in JSON)

....name0..1StringName of system

....target0..1Reference (Device)Particular delivery destination within the destination

.....id0..1Idxml:id (or equivalent in JSON)

.....reference0..1StringRelative, internal or absolute URL reference

.....display0..1StringText alternative for the resource

....endpoint1..1UriActual destination address or id
Example Value urn:nhs-uk:addressing:ods:RHM

...enterer0..1Reference (CareConnect-Practitioner-1)The source of the data entry

....id0..1Idxml:id (or equivalent in JSON)

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...author0..1Reference (CareConnect-Practitioner-1)The source of the decision

....id0..1Idxml:id (or equivalent in JSON)

....reference0..1StringRelative, internal or absolute URL reference

....display0..1StringText alternative for the resource

...receiver0..1Reference (CareConnect-Practitioner-1 | CareConnect-Organization-1)Intended "real-world" recipient for the data

...responsible0..1Reference (CareConnect-Practitioner-1 | CareConnect-Organization-1)Final responsibility for event.

...reason0..1CodeableConceptCause of event
Binding Reason for event occurrence (http://hl7.org/fhir/ValueSet/message-reason-encounter)
Binding Strength Example

....id0..1Idxml:id (or equivalent in JSON)

....coding0..*CodingCode defined by a terminology system

.....id0..1Idxml:id (or equivalent in JSON)

.....system0..1UriIdentity of the terminology system

.....version0..1StringVersion of the system - if relevant

.....code0..1CodeSymbol in syntax defined by the system

.....display0..1StringRepresentation defined by the system

.....userSelected0..1BooleanIf this coding was chosen directly by the user

....text0..1StringPlain text representation of the concept

...data0..*Reference (Resource)The actual content of the message

....id0..1Idxml:id (or equivalent in JSON)

Name Type Description & Constraints
. . Extension-ITK-MessageHandling-1 Extension Complex extension to support the ITK message handling key.
. . Extension-senderReference-1 Extension Extension to capture a local sender reference.
. . Extension-COFE-Care-Setting-Type-1 Extension Extension for a Care Setting.
Path Name Binding Strength ValueSet
.MessageHeader.language language Required http://tools.ietf.org/html/bcp47
.MessageHeader.event event Preferred http://hl7.org/fhir/ValueSet/message-events
.MessageHeader.event Document Required https://fhir.nhs.uk/ValueSet/document-type-1
.MessageHeader.event.code code Preferred https://fhir.nhs.uk/ValueSet/document-type-1
.MessageHeader.event Message Preferred http://hl7.org/fhir/ValueSet/message-events
.MessageHeader.response.code code Required http://hl7.org/fhir/ValueSet/response-code
.MessageHeader.source.contact.system system Required http://hl7.org/fhir/ValueSet/contact-point-system
.MessageHeader.source.contact.use use Required http://hl7.org/fhir/ValueSet/contact-point-use
.MessageHeader.reason reason Example http://hl7.org/fhir/ValueSet/message-reason-encounter