US Public Health Profiles Library
1.0.0 - STU1
US Public Health Profiles Library
1.0.0 - STU1
This page is part of the US Public Health Profiles Library (v1.0.0: STU 1) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Official URL: http://hl7.org/fhir/us/ph-library/StructureDefinition/us-ph-messagedefinition | Version: 1.0.0 | |||
| Active as of 2023-08-17 | Computable Name: USPublicHealthMessageDefinition | |||
This MessageDefinition profile represents the characteristics of a message that can be shared in public health.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageDefinition | 0..* | MessageDefinition | A resource that defines a type of message that can be exchanged between systems | |
  event[x] | S | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health VaueSet - 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 | ||||
| Path | Conformance | ValueSet |
| MessageDefinition.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageDefinition | C | 0..* | MessageDefinition | A resource that defines a type of message that can be 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 |
| 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 VaueSet - 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 | ||||
| Path | Conformance | ValueSet |
| MessageDefinition.status | required | PublicationStatus |
| MessageDefinition.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types) |
| MessageDefinition.category | required | MessageSignificanceCategory |
| MessageDefinition.focus.code | required | ResourceType |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageDefinition | C | 0..* | MessageDefinition | A resource that defines a type of message that can be 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 | ||||
| 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 | |||||
| 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 VaueSet - 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| MessageDefinition.language | preferred | CommonLanguages
| ||||
| MessageDefinition.status | required | PublicationStatus | ||||
| MessageDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| MessageDefinition.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types) | ||||
| MessageDefinition.category | required | MessageSignificanceCategory | ||||
| MessageDefinition.focus.code | required | ResourceType | ||||
| MessageDefinition.responseRequired | required | messageheader-response-request |
This structure is derived from MessageDefinition
Differential View
This structure is derived from MessageDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageDefinition | 0..* | MessageDefinition | A resource that defines a type of message that can be exchanged between systems | |
| event[x] | S | 1..1 | Coding | Types of messages being sent between systems Binding: US Public Health VaueSet - 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 | ||||
| Path | Conformance | ValueSet |
| MessageDefinition.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageDefinition | C | 0..* | MessageDefinition | A resource that defines a type of message that can be 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 |
| 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 VaueSet - 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 | ||||
| Path | Conformance | ValueSet |
| MessageDefinition.status | required | PublicationStatus |
| MessageDefinition.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types) |
| MessageDefinition.category | required | MessageSignificanceCategory |
| MessageDefinition.focus.code | required | ResourceType |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageDefinition | C | 0..* | MessageDefinition | A resource that defines a type of message that can be 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 | ||||
| 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 | |||||
| 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 VaueSet - 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 | ||||||||
| Path | Conformance | ValueSet | ||||
| MessageDefinition.language | preferred | CommonLanguages
| ||||
| MessageDefinition.status | required | PublicationStatus | ||||
| MessageDefinition.jurisdiction | extensible | Jurisdiction ValueSet | ||||
| MessageDefinition.event[x] | extensible | USPublicHealthValueSetMessageTypes (a valid code from US Public Health CodeSystem - Message Types) | ||||
| MessageDefinition.category | required | MessageSignificanceCategory | ||||
| MessageDefinition.focus.code | required | ResourceType | ||||
| MessageDefinition.responseRequired | required | messageheader-response-request |
This structure is derived from MessageDefinition
Other representations of profile: CSV, Excel, Schematron
IG © 2023+ HL7 Public Health Working Group. Package hl7.fhir.us.ph-library#1.0.0 based on FHIR 4.0.1. Generated 2023-08-17
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change