Vital Records FHIR Messaging (VRFM) IG
1.0.1
- release
Vital Records FHIR Messaging (VRFM) IG
1.0.1
- release
Vital Records FHIR Messaging (VRFM) IG - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://cdc.gov/nchs/nvss/fhir/vital-records-messaging/StructureDefinition/VRM-AliasHeader | Version: 1.0.1 | |||
| Draft as of 2023-12-28 | Responsible: CDC NCHS | Computable Name: AliasHeader | ||
Alias Header
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
  id | 1..1 | id | Logical id of this artifact | |
  Slices for event[x] | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
   event[x]:eventUri | 1..1 | uri | Code for the event this message represents or link to event definition Fixed Value: http://nchs.cdc.gov/vrdr_alias | |
| destination | 1..* | BackboneElement | Message destination application(s) | |
  focus | 1..2 | Reference(Alias Message Parameters) | The actual content of the message | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
 id | Σ | 1..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| Slices for event[x] | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. |
| event[x]:eventUri | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Fixed Value: http://nchs.cdc.gov/vrdr_alias |
 destination | Σ | 1..* | BackboneElement | Message destination application(s) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint | Σ | 1..1 | url | Actual destination address or id |
| source | Σ | 1..1 | BackboneElement | Message source application |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint | Σ | 1..1 | url | Actual message source address or id |
| focus | ΣC | 1..2 | Reference(Alias Message Parameters) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| MessageHeader.event[x] | example | MessageEvent |
| MessageHeader.event[x]:eventUri | example | Fixed Value: http://nchs.cdc.gov/vrdr_alias |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id | Σ | 1..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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| Slices for event[x] | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | ||||
| event[x]:eventUri | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Fixed Value: http://nchs.cdc.gov/vrdr_alias | ||||
| destination | Σ | 1..* | BackboneElement | Message destination application(s) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | Σ | 0..1 | string | Name of system | ||||
| target | ΣC | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint | Σ | 1..1 | url | Actual destination address or id | ||||
| receiver | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
| sender | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
| enterer | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source | Σ | 1..1 | BackboneElement | Message source application | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | Σ | 0..1 | string | Name of system | ||||
| software | Σ | 0..1 | string | Name of software running the system | ||||
| version | Σ | 0..1 | string | Version of software running | ||||
| contact | ΣC | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint | Σ | 1..1 | url | Actual message source address or id | ||||
| responsible | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
| reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
| response | Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier | Σ | 1..1 | id | Id of original message | ||||
| code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details | ΣC | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus | ΣC | 1..2 | Reference(Alias Message Parameters) | The actual content of the message | ||||
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | example | MessageEvent | ||||
| MessageHeader.event[x]:eventUri | example | Fixed Value: http://nchs.cdc.gov/vrdr_alias | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodes | ||||
| MessageHeader.response.code | required | ResponseType |
This structure is derived from MessageHeader
Summary
Mandatory: 4 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MessageHeader
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| id | 1..1 | id | Logical id of this artifact | |
| Slices for event[x] | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
| event[x]:eventUri | 1..1 | uri | Code for the event this message represents or link to event definition Fixed Value: http://nchs.cdc.gov/vrdr_alias | |
| destination | 1..* | BackboneElement | Message destination application(s) | |
| focus | 1..2 | Reference(Alias Message Parameters) | The actual content of the message | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| id | Σ | 1..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
| Slices for event[x] | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. |
| event[x]:eventUri | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Fixed Value: http://nchs.cdc.gov/vrdr_alias |
| destination | Σ | 1..* | BackboneElement | Message destination application(s) |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint | Σ | 1..1 | url | Actual destination address or id |
| source | Σ | 1..1 | BackboneElement | Message source application |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| endpoint | Σ | 1..1 | url | Actual message source address or id |
| focus | ΣC | 1..2 | Reference(Alias Message Parameters) | The actual content of the message |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| MessageHeader.event[x] | example | MessageEvent |
| MessageHeader.event[x]:eventUri | example | Fixed Value: http://nchs.cdc.gov/vrdr_alias |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
| id | Σ | 1..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 | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
| Slices for event[x] | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. | ||||
| event[x]:eventUri | Σ | 1..1 | uri | Code for the event this message represents or link to event definition Binding: MessageEvent (example): One of the message events defined as part of this version of FHIR. Fixed Value: http://nchs.cdc.gov/vrdr_alias | ||||
| destination | Σ | 1..* | BackboneElement | Message destination application(s) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | Σ | 0..1 | string | Name of system | ||||
| target | ΣC | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint | Σ | 1..1 | url | Actual destination address or id | ||||
| receiver | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
| sender | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message | ||||
| enterer | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author | ΣC | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
| source | Σ | 1..1 | BackboneElement | Message source application | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | Σ | 0..1 | string | Name of system | ||||
| software | Σ | 0..1 | string | Name of software running the system | ||||
| version | Σ | 0..1 | string | Version of software running | ||||
| contact | ΣC | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint | Σ | 1..1 | url | Actual message source address or id | ||||
| responsible | ΣC | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
| reason | Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
| response | Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| identifier | Σ | 1..1 | id | Id of original message | ||||
| code | Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
| details | ΣC | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus | ΣC | 1..2 | Reference(Alias Message Parameters) | The actual content of the message | ||||
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | example | MessageEvent | ||||
| MessageHeader.event[x]:eventUri | example | Fixed Value: http://nchs.cdc.gov/vrdr_alias | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodes | ||||
| MessageHeader.response.code | required | ResponseType |
This structure is derived from MessageHeader
Summary
Mandatory: 4 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron