US Public Health Profiles Library, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-us-ph-library/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-messagedefinition | Version: 2.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-23 | Maturity Level: 3 | Computable Name: USPublicHealthMessageDefinition | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.58.42.38 | ||||
This MessageDefinition profile represents the characteristics of a message that can be shared in public health.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  MessageDefinition |
C | 0..* | MessageDefinition(4.0.1) | US Public Health MessageDefinition Constraints: msd-0 |
  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 |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| date |
Σ | 1..1 | dateTime | Date last changed |
 event[x] |
SΣ | 1..1 | Coding | Types of messages being sent between systems Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet |
| category |
SΣ | 0..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. |
 focus |
SΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event Constraints: md-1 |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| code |
SΣ | 1..1 | code | Type of resource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| profile |
S | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus |
 min |
Σ | 1..1 | unsignedInt | Minimum number of focuses of this type |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| MessageDefinition.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📍2.0.0 | This IG |
| MessageDefinition.category | Base | required | MessageSignificanceCategory | 📍4.0.1 | FHIR Std. |
| MessageDefinition.focus.code | Base | required | ResourceType | 📍4.0.1 | 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 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(canonical) = '#').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], MessageDefinition.category, MessageDefinition.focus, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.code, MessageDefinition.focus.profile, MessageDefinition.focus.min | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MessageDefinition.modifierExtension, MessageDefinition.focus.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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageDefinition |
0..* | MessageDefinition(4.0.1) | US Public Health MessageDefinition | |
| event[x] |
S | 1..1 | Coding | Types of messages being sent between systems Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet |
 category |
S | 0..1 | code | consequence | currency | notification |
| focus |
S | 0..* | BackboneElement | Resource(s) that are the subject of the event |
| code |
S | 1..1 | code | Type of resource |
| profile |
S | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageDefinition.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📍2.0.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MessageDefinition |
C | 0..* | MessageDefinition(4.0.1) | US Public Health MessageDefinition Constraints: msd-0 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
 extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Business Identifier for a given MessageDefinition | ||||
| identifier |
Σ | 0..* | Identifier | Primary key for the message definition on a given server | ||||
| version |
Σ | 0..1 | string | Business version of the message definition | ||||
| name |
ΣC | 0..1 | string | Name for this message definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this message definition (human friendly) | ||||
| replaces |
Σ | 0..* | canonical(MessageDefinition) | Takes the place of | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the message definition | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
Σ | 0..1 | markdown | Why this message definition is defined | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| base |
Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | ||||
| parent |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | ||||
| event[x] |
SΣ | 1..1 | Coding | Types of messages being sent between systems Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet | ||||
| category |
SΣ | 0..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. | ||||
 focus |
SΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event Constraints: md-1 | ||||
 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 | ||||
| code |
SΣ | 1..1 | code | Type of resource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| profile |
S | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | ||||
| min |
Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | ||||
| max |
C | 0..1 | string | Maximum number of focuses of this type | ||||
| responseRequired |
0..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. Example General: always | |||||
| allowedResponse |
0..* | BackboneElement | Responses to this 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 | ||||
| message |
1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | |||||
| situation |
0..1 | markdown | When should this response be used | |||||
| graph |
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.0.1 | FHIR Std. |
| MessageDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| MessageDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| MessageDefinition.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📍2.0.0 | This IG |
| MessageDefinition.category | Base | required | MessageSignificanceCategory | 📍4.0.1 | FHIR Std. |
| MessageDefinition.focus.code | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| MessageDefinition.responseRequired | Base | required | messageheader-response-request | 📍4.0.1 | 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 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(canonical) = '#').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.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.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.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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageDefinition |
C | 0..* | MessageDefinition(4.0.1) | US Public Health MessageDefinition Constraints: msd-0 |
| 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 |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
| date |
Σ | 1..1 | dateTime | Date last changed |
| event[x] |
SΣ | 1..1 | Coding | Types of messages being sent between systems Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet |
| category |
SΣ | 0..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. |
| focus |
SΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event Constraints: md-1 |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 |
| code |
SΣ | 1..1 | code | Type of resource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. |
| profile |
S | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus |
| min |
Σ | 1..1 | unsignedInt | Minimum number of focuses of this type |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| MessageDefinition.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📍2.0.0 | This IG |
| MessageDefinition.category | Base | required | MessageSignificanceCategory | 📍4.0.1 | FHIR Std. |
| MessageDefinition.focus.code | Base | required | ResourceType | 📍4.0.1 | 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 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(canonical) = '#').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], MessageDefinition.category, MessageDefinition.focus, MessageDefinition.focus.modifierExtension, MessageDefinition.focus.code, MessageDefinition.focus.profile, MessageDefinition.focus.min | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | MessageDefinition.modifierExtension, MessageDefinition.focus.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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| MessageDefinition |
0..* | MessageDefinition(4.0.1) | US Public Health MessageDefinition | |
| event[x] |
S | 1..1 | Coding | Types of messages being sent between systems Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet |
| category |
S | 0..1 | code | consequence | currency | notification |
| focus |
S | 0..* | BackboneElement | Resource(s) that are the subject of the event |
| code |
S | 1..1 | code | Type of resource |
| profile |
S | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| MessageDefinition.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📍2.0.0 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| MessageDefinition |
C | 0..* | MessageDefinition(4.0.1) | US Public Health MessageDefinition Constraints: msd-0 | ||||
| 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 | ||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| 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 | |||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
| url |
Σ | 0..1 | uri | Business Identifier for a given MessageDefinition | ||||
| identifier |
Σ | 0..* | Identifier | Primary key for the message definition on a given server | ||||
| version |
Σ | 0..1 | string | Business version of the message definition | ||||
| name |
ΣC | 0..1 | string | Name for this message definition (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this message definition (human friendly) | ||||
| replaces |
Σ | 0..* | canonical(MessageDefinition) | Takes the place of | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
| experimental |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
| date |
Σ | 1..1 | dateTime | Date last changed | ||||
| publisher |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
Σ | 0..1 | markdown | Natural language description of the message definition | ||||
| useContext |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for message definition (if applicable) Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use. | ||||
| purpose |
Σ | 0..1 | markdown | Why this message definition is defined | ||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| base |
Σ | 0..1 | canonical(MessageDefinition) | Definition this one is based on | ||||
| parent |
Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) | Protocol/workflow this is part of | ||||
| event[x] |
SΣ | 1..1 | Coding | Types of messages being sent between systems Binding: USPublicHealthValueSetMessageTypes (2.0.0) (extensible): US Public Health Message Types ValueSet | ||||
| category |
SΣ | 0..1 | code | consequence | currency | notification Binding: MessageSignificanceCategory (required): The impact of the content of a message. | ||||
| focus |
SΣC | 0..* | BackboneElement | Resource(s) that are the subject of the event Constraints: md-1 | ||||
| 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 | ||||
| code |
SΣ | 1..1 | code | Type of resource Binding: ResourceType (required): One of the resource types defined as part of this version of FHIR. | ||||
| profile |
S | 0..1 | canonical(StructureDefinition) | Profile that must be adhered to by focus | ||||
| min |
Σ | 1..1 | unsignedInt | Minimum number of focuses of this type | ||||
| max |
C | 0..1 | string | Maximum number of focuses of this type | ||||
| responseRequired |
0..1 | code | always | on-error | never | on-success Binding: messageheader-response-request (required): HL7-defined table of codes which identify conditions under which acknowledgments are required to be returned in response to a message. Example General: always | |||||
| allowedResponse |
0..* | BackboneElement | Responses to this 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 | ||||
| message |
1..1 | canonical(MessageDefinition) | Reference to allowed message definition response | |||||
| situation |
0..1 | markdown | When should this response be used | |||||
| graph |
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.0.1 | FHIR Std. |
| MessageDefinition.status | Base | required | PublicationStatus | 📍4.0.1 | FHIR Std. |
| MessageDefinition.jurisdiction | Base | extensible | Jurisdiction | 📍4.0.1 | FHIR Std. |
| MessageDefinition.event[x] | Base | extensible | US Public Health ValueSet - Message Types | 📍2.0.0 | This IG |
| MessageDefinition.category | Base | required | MessageSignificanceCategory | 📍4.0.1 | FHIR Std. |
| MessageDefinition.focus.code | Base | required | ResourceType | 📍4.0.1 | FHIR Std. |
| MessageDefinition.responseRequired | Base | required | messageheader-response-request | 📍4.0.1 | 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 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(canonical) = '#').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.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.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.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.matches('[A-Z]([A-Za-z0-9_]){0,254}')
|
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ HL7 International / Public Health.
Package hl7.fhir.us.ph-library#2.0.0 based on FHIR 4.0.1.
Generated 2025-10-23
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
