Universal API Implementation Guide - Local Development build (v1.1.19). See the Directory of published versions
Resource Profile: UAPI MessageHeader
| Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-messageheader | Version: 1.1.19 | |||
| Active as of 2020-12-11 | Responsible: Genentech USIX PE |
Realm: 
|
Computable Name: UapiMessageHeader | |
This profile constrains the MessageHeader resource to be included in each bundle
Usage:
- Use this Resource Profile: UAPI Bundle - Patient Consent Form Only Enrollment, UAPI Bundle - AS Enrollment, UAPI Bundle - Query Message, UAPI Bundle - Status Update, UAPI Bundle - Copay Enrollment, UAPI Bundle - Copay Management, UAPI Bundle - Copay Request-Response
- Examples for this Resource Profile: MessageHeader/3fe24402-d4b1-4add-b83d-43d0ee4b7dee
Formal Views of Profile Content
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 | |
  Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
 timestamp | 0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |
  Slices for event[x] | 1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
  event[x]:eventCoding | 1..1 | Coding | Code for the event this message represents or link to event definition | |
   system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type | |
 code | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) | |
 sender | 1..1 | Reference(UAPI Organization) | Reference to Organization resource representing specific Hospital/Practice which has the Vendor System deployed and is sending the message to Genentech | |
| source | ||||
| name | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System | |
 endpoint | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 | |
| focus | 1..1 | Reference(List | Parameters) | List of all resources in the message | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType (a valid code from UAPI Code System - Event Type) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| timestamp | 0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for event[x] | Σ | 1..1 | Coding | 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]:eventCoding | Σ | 1..1 | Coding | 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. |
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) |
| sender | Σ | 1..1 | Reference(UAPI Organization) | Reference to Organization resource representing specific Hospital/Practice which has the Vendor System deployed and is sending the message to Genentech |
 source | Σ | 1..1 | BackboneElement | Message source application |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | Σ | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System |
| endpoint | Σ | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 |
| focus | Σ | 1..1 | Reference(List | Parameters) | List of all resources in the message |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| MessageHeader.event[x] | example | MessageEvent |
| MessageHeader.event[x]:eventCoding | example | MessageEvent |
| MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType (a valid code from UAPI Code System - Event Type) |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timestamp | 0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for event[x] | Σ | 1..1 | Coding | 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]:eventCoding | Σ | 1..1 | Coding | 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. | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| destination | Σ | 0..* | BackboneElement | Message destination application(s) | ||||
| 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 | ||||
| name | Σ | 0..1 | string | Name of system | ||||
| target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint | Σ | 1..1 | url | Actual destination address or id | ||||
| receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
| sender | Σ | 1..1 | Reference(UAPI Organization) | Reference to Organization resource representing specific Hospital/Practice which has the Vendor System deployed and is sending the message to Genentech | ||||
| enterer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author | Σ | 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 | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | Σ | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System | ||||
| software | Σ | 0..1 | string | Name of software running the system | ||||
| version | Σ | 0..1 | string | Version of software running | ||||
| contact | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint | Σ | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 | ||||
| responsible | Σ | 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 | 0..* | Extension | Additional content defined by implementations | |||||
| 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 | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus | Σ | 1..1 | Reference(List | Parameters) | List of all resources in the message | ||||
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | example | MessageEvent | ||||
| MessageHeader.event[x]:eventCoding | example | MessageEvent | ||||
| MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType (a valid code from UAPI Code System - Event Type) | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodes | ||||
| MessageHeader.response.code | required | ResponseType |
This structure is derived from MessageHeader
Summary
Mandatory: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element MessageHeader.event[x] is sliced based on the value of type:$this
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 | |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| timestamp | 0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |
| Slices for event[x] | 1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
| event[x]:eventCoding | 1..1 | Coding | Code for the event this message represents or link to event definition | |
| system | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type | |
| code | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) | |
| sender | 1..1 | Reference(UAPI Organization) | Reference to Organization resource representing specific Hospital/Practice which has the Vendor System deployed and is sending the message to Genentech | |
| source | ||||
| name | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System | |
| endpoint | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 | |
| focus | 1..1 | Reference(List | Parameters) | List of all resources in the message | |
| Documentation for this format | ||||
Terminology Bindings (Differential)
| Path | Conformance | ValueSet |
| MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType (a valid code from UAPI Code System - Event Type) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| timestamp | 0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| Slices for event[x] | Σ | 1..1 | Coding | 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]:eventCoding | Σ | 1..1 | Coding | 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. |
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type |
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) |
| sender | Σ | 1..1 | Reference(UAPI Organization) | Reference to Organization resource representing specific Hospital/Practice which has the Vendor System deployed and is sending the message to Genentech |
| source | Σ | 1..1 | BackboneElement | Message source application |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| name | Σ | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System |
| endpoint | Σ | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 |
| focus | Σ | 1..1 | Reference(List | Parameters) | List of all resources in the message |
| Documentation for this format | ||||
Terminology Bindings
| Path | Conformance | ValueSet |
| MessageHeader.event[x] | example | MessageEvent |
| MessageHeader.event[x]:eventCoding | example | MessageEvent |
| MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType (a valid code from UAPI Code System - Event Type) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MessageHeader | 0..* | MessageHeader | A resource that describes a message that is 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): IETF language tag
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| timestamp | 0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| Slices for event[x] | Σ | 1..1 | Coding | 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]:eventCoding | Σ | 1..1 | Coding | 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. | ||||
| id | 0..1 | id | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| system | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| destination | Σ | 0..* | BackboneElement | Message destination application(s) | ||||
| 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 | ||||
| name | Σ | 0..1 | string | Name of system | ||||
| target | Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
| endpoint | Σ | 1..1 | url | Actual destination address or id | ||||
| receiver | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
| sender | Σ | 1..1 | Reference(UAPI Organization) | Reference to Organization resource representing specific Hospital/Practice which has the Vendor System deployed and is sending the message to Genentech | ||||
| enterer | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
| author | Σ | 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 | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| name | Σ | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System | ||||
| software | Σ | 0..1 | string | Name of software running the system | ||||
| version | Σ | 0..1 | string | Version of software running | ||||
| contact | Σ | 0..1 | ContactPoint | Human contact for problems | ||||
| endpoint | Σ | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 | ||||
| responsible | Σ | 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 | 0..* | Extension | Additional content defined by implementations | |||||
| 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 | Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
| focus | Σ | 1..1 | Reference(List | Parameters) | List of all resources in the message | ||||
| definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
| Documentation for this format | ||||||||
Terminology Bindings
| Path | Conformance | ValueSet | ||||
| MessageHeader.language | preferred | CommonLanguages
| ||||
| MessageHeader.event[x] | example | MessageEvent | ||||
| MessageHeader.event[x]:eventCoding | example | MessageEvent | ||||
| MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType (a valid code from UAPI Code System - Event Type) | ||||
| MessageHeader.reason | example | ExampleMessageReasonCodes | ||||
| MessageHeader.response.code | required | ResponseType |
This structure is derived from MessageHeader
Summary
Mandatory: 6 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
- The element MessageHeader.event[x] is sliced based on the value of type:$this
Other representations of profile: CSV, Excel, Schematron