Making Electronic Data More available for Research and Public Health (MedMorph)
1.0.0 - STU 1

Making Electronic Data More available for Research and Public Health (MedMorph), published by HL7 International - Public Health Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-medmorph/ and changes regularly. See the Directory of published versions

## Resource Profile: US Public Health MessageDefinition

Official URL: http://hl7.org/fhir/us/medmorph/StructureDefinition/us-ph-messagedefinition | Version: 1.0.0
Draft as of 2019-09-01 | Computable Name: USPublicHealthMessageDefinition

This is the MessageDefinition Resource profile for the IG.

Usage:

- Refer to this Resource Profile: US Public Health MessageHeader
- Examples for this Resource Profile: MessageDefinition/messagedefinition-example-contentbundle

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from MessageDefinition

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageDefinition |  | 0..* | MessageDefinition | US Public Health MessageDefinition
event[x] | S | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health Message Types (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

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
MessageDefinition.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageDefinition | C | 0..* | MessageDefinition | US Public Health MessageDefinition
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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: US Public Health Message Types (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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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

#### Terminology Bindings

Path | Conformance | ValueSet
MessageDefinition.status | required | PublicationStatus
MessageDefinition.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageDefinition.category | required | MessageSignificanceCategory
MessageDefinition.focus.code | required | ResourceType

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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
--- | --- | --- | --- | ---
MessageDefinition | C | 0..* | MessageDefinition | US Public Health MessageDefinition
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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: US Public Health Message Types (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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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

#### Terminology Bindings

Path | Conformance | ValueSet
MessageDefinition.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
MessageDefinition.status | required | PublicationStatus
MessageDefinition.jurisdiction | extensible | Jurisdiction ValueSet
MessageDefinition.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageDefinition.category | required | MessageSignificanceCategory
MessageDefinition.focus.code | required | ResourceType
MessageDefinition.responseRequired | required | messageheader-response-request

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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) |

This structure is derived from MessageDefinition

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 5 elements

Differential View

This structure is derived from MessageDefinition

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageDefinition |  | 0..* | MessageDefinition | US Public Health MessageDefinition
event[x] | S | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health Message Types (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

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
MessageDefinition.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageDefinition | C | 0..* | MessageDefinition | US Public Health MessageDefinition
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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: US Public Health Message Types (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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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

#### Terminology Bindings

Path | Conformance | ValueSet
MessageDefinition.status | required | PublicationStatus
MessageDefinition.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageDefinition.category | required | MessageSignificanceCategory
MessageDefinition.focus.code | required | ResourceType

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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}') |

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
MessageDefinition | C | 0..* | MessageDefinition | US Public Health MessageDefinition
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.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
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: US Public Health Message Types (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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
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

#### Terminology Bindings

Path | Conformance | ValueSet
MessageDefinition.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
MessageDefinition.status | required | PublicationStatus
MessageDefinition.jurisdiction | extensible | Jurisdiction ValueSet
MessageDefinition.event[x] | extensible | USPublicHealthMessageTypes (a valid code from US Public Health Message Type Codes)
MessageDefinition.category | required | MessageSignificanceCategory
MessageDefinition.focus.code | required | ResourceType
MessageDefinition.responseRequired | required | messageheader-response-request

#### Constraints

Id | Grade | Path(s) | Details | Requirements
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | error | **ALL** extensions | 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) |

This structure is derived from MessageDefinition

Summary

Mandatory: 1 element (1 nested mandatory element)
Must-Support: 5 elements

Other representations of profile: CSV, Excel, Schematron