Extensions for Using Data Elements from FHIR R4 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_MessageHeader_R4B

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-MessageHeader Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_MessageHeader_R4B

This cross-version profile allows R4 MessageHeader content to be represented via FHIR R4B MessageHeader resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.3.0) A resource that describes a message that is exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... event[x] Σ 1..1 Code for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
.... eventCoding Coding
.... eventUri uri
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... endpoint Σ 1..1 url Actual message source address or id

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base example MessageEvent 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
ele-1 error MessageHeader.implicitRules, MessageHeader.modifierExtension, MessageHeader.event[x], MessageHeader.source, MessageHeader.source.modifierExtension, MessageHeader.source.endpoint All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageHeader.modifierExtension, MessageHeader.source.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.3.0) A resource that describes a message that is exchanged between systems

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.3.0) A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... event[x] Σ 1..1 Code for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
.... eventCoding Coding
.... eventUri uri
... destination Σ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
... response Σ 0..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... identifier Σ 1..1 id Id of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* Reference(Resource) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.language Base preferred Common Languages 📍4.3.0 FHIR Std.
MessageHeader.event[x] Base example MessageEvent 📍4.3.0 FHIR Std.
MessageHeader.reason Base example Example Message Reason Codes 📍4.3.0 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning MessageHeader.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error MessageHeader.meta, MessageHeader.implicitRules, MessageHeader.language, MessageHeader.text, MessageHeader.extension, MessageHeader.modifierExtension, MessageHeader.event[x], MessageHeader.destination, MessageHeader.destination.extension, MessageHeader.destination.modifierExtension, MessageHeader.destination.name, MessageHeader.destination.target, MessageHeader.destination.endpoint, MessageHeader.destination.receiver, MessageHeader.sender, MessageHeader.enterer, MessageHeader.author, MessageHeader.source, MessageHeader.source.extension, MessageHeader.source.modifierExtension, MessageHeader.source.name, MessageHeader.source.software, MessageHeader.source.version, MessageHeader.source.contact, MessageHeader.source.endpoint, MessageHeader.responsible, MessageHeader.reason, MessageHeader.response, MessageHeader.response.extension, MessageHeader.response.modifierExtension, MessageHeader.response.identifier, MessageHeader.response.code, MessageHeader.response.details, MessageHeader.focus, MessageHeader.definition All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageHeader.extension, MessageHeader.modifierExtension, MessageHeader.destination.extension, MessageHeader.destination.modifierExtension, MessageHeader.source.extension, MessageHeader.source.modifierExtension, MessageHeader.response.extension, MessageHeader.response.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.3.0) A resource that describes a message that is exchanged between systems
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... event[x] Σ 1..1 Code for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
.... eventCoding Coding
.... eventUri uri
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... endpoint Σ 1..1 url Actual message source address or id

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.event[x] Base example MessageEvent 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
ele-1 error MessageHeader.implicitRules, MessageHeader.modifierExtension, MessageHeader.event[x], MessageHeader.source, MessageHeader.source.modifierExtension, MessageHeader.source.endpoint All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageHeader.modifierExtension, MessageHeader.source.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.3.0) A resource that describes a message that is exchanged between systems

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MessageHeader 0..* MessageHeader(4.3.0) A resource that describes a message that is exchanged between systems
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... event[x] Σ 1..1 Code for the event this message represents or link to event definition
Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR.
.... eventCoding Coding
.... eventUri uri
... destination Σ 0..* BackboneElement Message destination application(s)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name Σ 0..1 string Name of system
.... target Σ 0..1 Reference(Device) Particular delivery destination within the destination
.... endpoint Σ 1..1 url Actual destination address or id
.... receiver Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Intended "real-world" recipient for the data
... sender Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Real world sender of the message
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the data entry
... author Σ 0..1 Reference(Practitioner | PractitionerRole) The source of the decision
... source Σ 1..1 BackboneElement Message source application
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... name Σ 0..1 string Name of system
.... software Σ 0..1 string Name of software running the system
.... version Σ 0..1 string Version of software running
.... contact Σ 0..1 ContactPoint Human contact for problems
.... endpoint Σ 1..1 url Actual message source address or id
... responsible Σ 0..1 Reference(Practitioner | PractitionerRole | Organization) Final responsibility for event
... reason Σ 0..1 CodeableConcept Cause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.
... response Σ 0..1 BackboneElement If this is a reply to prior message
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... identifier Σ 1..1 id Id of original message
.... code Σ 1..1 code ok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.
.... details Σ 0..1 Reference(OperationOutcome) Specific list of hints/warnings/errors
... focus Σ 0..* Reference(Resource) The actual content of the message
... definition Σ 0..1 canonical(MessageDefinition) Link to the definition for this message

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MessageHeader.language Base preferred Common Languages 📍4.3.0 FHIR Std.
MessageHeader.event[x] Base example MessageEvent 📍4.3.0 FHIR Std.
MessageHeader.reason Base example Example Message Reason Codes 📍4.3.0 FHIR Std.
MessageHeader.response.​code Base required ResponseType 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error MessageHeader If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error MessageHeader If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where(((id.exists() and ('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url)))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error MessageHeader If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice MessageHeader A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning MessageHeader.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error MessageHeader.meta, MessageHeader.implicitRules, MessageHeader.language, MessageHeader.text, MessageHeader.extension, MessageHeader.modifierExtension, MessageHeader.event[x], MessageHeader.destination, MessageHeader.destination.extension, MessageHeader.destination.modifierExtension, MessageHeader.destination.name, MessageHeader.destination.target, MessageHeader.destination.endpoint, MessageHeader.destination.receiver, MessageHeader.sender, MessageHeader.enterer, MessageHeader.author, MessageHeader.source, MessageHeader.source.extension, MessageHeader.source.modifierExtension, MessageHeader.source.name, MessageHeader.source.software, MessageHeader.source.version, MessageHeader.source.contact, MessageHeader.source.endpoint, MessageHeader.responsible, MessageHeader.reason, MessageHeader.response, MessageHeader.response.extension, MessageHeader.response.modifierExtension, MessageHeader.response.identifier, MessageHeader.response.code, MessageHeader.response.details, MessageHeader.focus, MessageHeader.definition All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error MessageHeader.extension, MessageHeader.modifierExtension, MessageHeader.destination.extension, MessageHeader.destination.modifierExtension, MessageHeader.source.extension, MessageHeader.source.modifierExtension, MessageHeader.response.extension, MessageHeader.response.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from MessageHeader

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron