Extensions for Using Data Elements from FHIR R4 in FHIR R4B - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-MessageDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R4_MessageDefinition_R4B | ||
This cross-version profile allows R4 MessageDefinition content to be represented via FHIR R4B MessageDefinition resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | MessageDefinition(4.3.0) | A resource that defines a type of message that can be exchanged between systems Constraints: msd-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 1..1 | dateTime | Date last changed |
![]() ![]() |
Σ | 1..1 | Event code or link to the EventDefinition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |
![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() |
uri | |||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageDefinition.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| MessageDefinition.event[x] | Base | example | MessageEvent | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MessageDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MessageDefinition | 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 | MessageDefinition | 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 | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MessageDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | MessageDefinition.implicitRules, MessageDefinition.modifierExtension, MessageDefinition.status, MessageDefinition.date, MessageDefinition.event[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MessageDefinition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| msd-0 | warning | MessageDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
This structure is derived from MessageDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MessageDefinition(4.3.0) | A resource that defines a type of message that can be exchanged between systems | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | R4: code URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.focus.code Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR. | |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | MessageDefinition(4.3.0) | A resource that defines a type of message that can be exchanged between systems Constraints: msd-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..1 | uri | Business Identifier for a given MessageDefinition | ||||
![]() ![]() |
Σ | 0..* | Identifier | Primary key for the message definition on a given server | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the message definition | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this message definition (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this message definition (human friendly) | ||||
![]() ![]() |
Σ | 0..* | canonical(MessageDefinition) | Takes the place of | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 1..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the message definition | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
Σ | 0..1 | markdown | Why this message definition is defined | ||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | ||||
![]() ![]() |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | ||||
![]() ![]() |
Σ | 1..1 | Event code or link to the EventDefinition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |||||
![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
uri | |||||||
![]() ![]() |
Σ | 0..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. | ||||
![]() ![]() |
ΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event Constraints: md-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | Type of resource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | R4: code URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.focus.code Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() ![]() |
0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | |||||
![]() ![]() ![]() |
Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | ||||
![]() ![]() ![]() |
C | 0..1 | string | Maximum number of focuses of this type | ||||
![]() ![]() |
0..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never. Example General: always | |||||
![]() ![]() |
0..* | BackboneElement | Responses to this message | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | |||||
![]() ![]() ![]() |
0..1 | markdown | When should this response be used | |||||
![]() ![]() |
0..* | canonical(GraphDefinition) | Canonical reference to a GraphDefinition | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageDefinition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| MessageDefinition.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| MessageDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| MessageDefinition.event[x] | Base | example | MessageEvent | 📍4.3.0 | FHIR Std. |
| MessageDefinition.category | Base | required | MessageSignificanceCategory | 📍4.3.0 | FHIR Std. |
| MessageDefinition.focus.code | Base | required | ResourceType | 📍4.3.0 | FHIR Std. |
| MessageDefinition.responseRequired | Base | required | messageheader-response-request | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MessageDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MessageDefinition | 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 | MessageDefinition | 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 | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MessageDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | MessageDefinition.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 | MessageDefinition.meta, MessageDefinition.implicitRules, MessageDefinition.language, MessageDefinition.text, MessageDefinition.extension, MessageDefinition.modifierExtension, MessageDefinition.url, MessageDefinition.identifier, MessageDefinition.version, MessageDefinition.name, MessageDefinition.title, MessageDefinition.replaces, MessageDefinition.status, MessageDefinition.experimental, MessageDefinition.date, MessageDefinition.publisher, MessageDefinition.contact, MessageDefinition.description, MessageDefinition.useContext, MessageDefinition.jurisdiction, MessageDefinition.purpose, MessageDefinition.copyright, MessageDefinition.base, MessageDefinition.parent, MessageDefinition.event[x], MessageDefinition.category, MessageDefinition.focus, MessageDefinition.focus.extension, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.code, MessageDefinition.focus.code.extension, MessageDefinition.focus.code.extension:code, MessageDefinition.focus.profile, MessageDefinition.focus.min, MessageDefinition.focus.max, MessageDefinition.responseRequired, MessageDefinition.allowedResponse, MessageDefinition.allowedResponse.extension, MessageDefinition.allowedResponse.modifierExtension, MessageDefinition.allowedResponse.message, MessageDefinition.allowedResponse.situation, MessageDefinition.graph | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MessageDefinition.extension, MessageDefinition.modifierExtension, MessageDefinition.focus.extension, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.code.extension, MessageDefinition.focus.code.extension:code, MessageDefinition.allowedResponse.extension, MessageDefinition.allowedResponse.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| md-1 | error | MessageDefinition.focus | Max must be postive int or * |
max='*' or (max.toInteger() > 0)
|
| msd-0 | warning | MessageDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
This structure is derived from MessageDefinition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | MessageDefinition(4.3.0) | A resource that defines a type of message that can be exchanged between systems Constraints: msd-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 1..1 | dateTime | Date last changed |
![]() ![]() |
Σ | 1..1 | Event code or link to the EventDefinition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |
![]() ![]() ![]() |
Coding | |||
![]() ![]() ![]() |
uri | |||
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageDefinition.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| MessageDefinition.event[x] | Base | example | MessageEvent | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MessageDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MessageDefinition | 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 | MessageDefinition | 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 | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MessageDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | MessageDefinition.implicitRules, MessageDefinition.modifierExtension, MessageDefinition.status, MessageDefinition.date, MessageDefinition.event[x] | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MessageDefinition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| msd-0 | warning | MessageDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Differential View
This structure is derived from MessageDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | MessageDefinition(4.3.0) | A resource that defines a type of message that can be exchanged between systems | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | R4: code URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.focus.code Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR. | |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | MessageDefinition(4.3.0) | A resource that defines a type of message that can be exchanged between systems Constraints: msd-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..1 | uri | Business Identifier for a given MessageDefinition | ||||
![]() ![]() |
Σ | 0..* | Identifier | Primary key for the message definition on a given server | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the message definition | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this message definition (computer friendly) | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this message definition (human friendly) | ||||
![]() ![]() |
Σ | 0..* | canonical(MessageDefinition) | Takes the place of | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 1..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the message definition | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
![]() ![]() |
Σ | 0..1 | markdown | Why this message definition is defined | ||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | ||||
![]() ![]() |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | ||||
![]() ![]() |
Σ | 1..1 | Event code or link to the EventDefinition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | |||||
![]() ![]() ![]() |
Coding | |||||||
![]() ![]() ![]() |
uri | |||||||
![]() ![]() |
Σ | 0..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. | ||||
![]() ![]() |
ΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event Constraints: md-1 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 1..1 | code | Type of resource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | code | R4: code URL: http://hl7.org/fhir/4.0/StructureDefinition/extension-MessageDefinition.focus.code Binding: http://hl7.org/fhir/uv/xver/ValueSet/R4-resource-types-for-R4B (required): One of the resource types defined as part of this version of FHIR. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() ![]() |
0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | |||||
![]() ![]() ![]() |
Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | ||||
![]() ![]() ![]() |
C | 0..1 | string | Maximum number of focuses of this type | ||||
![]() ![]() |
0..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): This enables the capability currently available through MSH-16 (Application Level acknowledgement) in HL7 Version 2 to declare at a message definition level whether a response is required or only upon error or success, or never. Example General: always | |||||
![]() ![]() |
0..* | BackboneElement | Responses to this message | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | |||||
![]() ![]() ![]() |
0..1 | markdown | When should this response be used | |||||
![]() ![]() |
0..* | canonical(GraphDefinition) | Canonical reference to a GraphDefinition | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageDefinition.language | Base | preferred | Common Languages | 📍4.3.0 | FHIR Std. |
| MessageDefinition.status | Base | required | PublicationStatus | 📍4.3.0 | FHIR Std. |
| MessageDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.3.0 | FHIR Std. |
| MessageDefinition.event[x] | Base | example | MessageEvent | 📍4.3.0 | FHIR Std. |
| MessageDefinition.category | Base | required | MessageSignificanceCategory | 📍4.3.0 | FHIR Std. |
| MessageDefinition.focus.code | Base | required | ResourceType | 📍4.3.0 | FHIR Std. |
| MessageDefinition.responseRequired | Base | required | messageheader-response-request | 📍4.3.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | MessageDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | MessageDefinition | 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 | MessageDefinition | 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 | MessageDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | MessageDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| dom-r4b | warning | MessageDefinition.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 | MessageDefinition.meta, MessageDefinition.implicitRules, MessageDefinition.language, MessageDefinition.text, MessageDefinition.extension, MessageDefinition.modifierExtension, MessageDefinition.url, MessageDefinition.identifier, MessageDefinition.version, MessageDefinition.name, MessageDefinition.title, MessageDefinition.replaces, MessageDefinition.status, MessageDefinition.experimental, MessageDefinition.date, MessageDefinition.publisher, MessageDefinition.contact, MessageDefinition.description, MessageDefinition.useContext, MessageDefinition.jurisdiction, MessageDefinition.purpose, MessageDefinition.copyright, MessageDefinition.base, MessageDefinition.parent, MessageDefinition.event[x], MessageDefinition.category, MessageDefinition.focus, MessageDefinition.focus.extension, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.code, MessageDefinition.focus.code.extension, MessageDefinition.focus.code.extension:code, MessageDefinition.focus.profile, MessageDefinition.focus.min, MessageDefinition.focus.max, MessageDefinition.responseRequired, MessageDefinition.allowedResponse, MessageDefinition.allowedResponse.extension, MessageDefinition.allowedResponse.modifierExtension, MessageDefinition.allowedResponse.message, MessageDefinition.allowedResponse.situation, MessageDefinition.graph | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MessageDefinition.extension, MessageDefinition.modifierExtension, MessageDefinition.focus.extension, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.code.extension, MessageDefinition.focus.code.extension:code, MessageDefinition.allowedResponse.extension, MessageDefinition.allowedResponse.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| md-1 | error | MessageDefinition.focus | Max must be postive int or * |
max='*' or (max.toInteger() > 0)
|
| msd-0 | warning | MessageDefinition | Name should be usable as an identifier for the module by machine processing applications such as code generation |
name.exists() implies name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
This structure is derived from MessageDefinition
Other representations of profile: CSV, Excel, Schematron