Universal API Implementation Guide
1.1.20 - ci-build
Universal API Implementation Guide - Local Development build (v1.1.20) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://fhir.developer.gene.com/StructureDefinition/uapi-messageheader | Version: 1.1.20 | |||
Active as of 2020-12-11 | Computable Name: UapiMessageHeader |
This profile constrains the MessageHeader resource to be included in each bundle
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 |
![]() ![]() ![]() |
Σ | 1..1 | Reference(List | Parameters) | List of all resources in the message |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events From the FHIR Standard | |
MessageHeader.event[x]:eventCoding | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events From the FHIR Standard | |
MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType(a valid code from UAPI Code System - Event Type)https://fhir.developer.gene.com/ValueSet/uapi-se-type From this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | 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() |
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
MessageHeader | |||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |
![]() ![]() ![]() |
1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code for the event this message represents or link to event definition | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System | |
![]() ![]() ![]() ![]() |
1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 | |
![]() ![]() ![]() |
1..1 | Reference(List | Parameters) | List of all resources in the message | |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType(a valid code from UAPI Code System - Event Type)https://fhir.developer.gene.com/ValueSet/uapi-se-type From this IG |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Message destination application(s) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of software running the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of software running | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | id | Id of original message | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(List | Parameters) | List of all resources in the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events From the FHIR Standard | ||||
MessageHeader.event[x]:eventCoding | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events From the FHIR Standard | ||||
MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType(a valid code from UAPI Code System - Event Type)https://fhir.developer.gene.com/ValueSet/uapi-se-type From this IG | ||||
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter From the FHIR Standard | ||||
MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.3.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
dom-r4b | warning | MessageHeader.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
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() |
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:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() |
Σ | 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. |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) |
![]() ![]() ![]() |
Σ | 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 |
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System |
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 |
![]() ![]() ![]() |
Σ | 1..1 | Reference(List | Parameters) | List of all resources in the message |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events From the FHIR Standard | |
MessageHeader.event[x]:eventCoding | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events From the FHIR Standard | |
MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType(a valid code from UAPI Code System - Event Type)https://fhir.developer.gene.com/ValueSet/uapi-se-type From this IG |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | 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() |
Differential View
This structure is derived from MessageHeader
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
MessageHeader | |||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |
![]() ![]() ![]() |
1..1 | Coding | Code for the event this message represents or link to event definition Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() |
1..1 | Coding | Code for the event this message represents or link to event definition | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) | |
![]() ![]() ![]() |
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 | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System | |
![]() ![]() ![]() ![]() |
1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 | |
![]() ![]() ![]() |
1..1 | Reference(List | Parameters) | List of all resources in the message | |
![]() |
Path | Conformance | ValueSet | URI |
MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType(a valid code from UAPI Code System - Event Type)https://fhir.developer.gene.com/ValueSet/uapi-se-type From this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | MessageHeader | A resource that describes a message that is exchanged between systems | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources Constraints: dom-r4b | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | UAPI MessageHeader Timestamp URL: https://fhir.developer.gene.com/StructureDefinition/message-timestamp | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | uri | Identity of the terminology system Required Pattern: http://terminology.gene.com/fhir/usix/uapi/CodeSystem/uapi-event-type | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | Symbol in syntax defined by the system Binding: UAPI Value Set - System Event Type (required) | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Message destination application(s) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Device) | Particular delivery destination within the destination | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Actual destination address or id | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data | ||||
![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision | ||||
![]() ![]() ![]() |
Σ | 1..1 | BackboneElement | Message source application | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | string | Source name provided by Genentech - this is unique identifier of Vendor System | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Name of software running the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of software running | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | ContactPoint | Human contact for problems | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | url | Last element of the URL after /enrollmentID is representing human readable transaction identifier, ex. enrollmentID/ENR-00001 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example): Reason for event occurrence. | ||||
![]() ![]() ![]() |
Σ | 0..1 | BackboneElement | If this is a reply to prior message | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | id | Id of original message | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required): The kind of response to a message. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors | ||||
![]() ![]() ![]() |
Σ | 1..1 | Reference(List | Parameters) | List of all resources in the message | ||||
![]() ![]() ![]() |
Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
MessageHeader.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
MessageHeader.event[x] | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events From the FHIR Standard | ||||
MessageHeader.event[x]:eventCoding | example | MessageEventhttp://hl7.org/fhir/ValueSet/message-events From the FHIR Standard | ||||
MessageHeader.event[x]:eventCoding.code | required | UapiValueSetSystemEventType(a valid code from UAPI Code System - Event Type)https://fhir.developer.gene.com/ValueSet/uapi-se-type From this IG | ||||
MessageHeader.reason | example | ExampleMessageReasonCodeshttp://hl7.org/fhir/ValueSet/message-reason-encounter From the FHIR Standard | ||||
MessageHeader.response.code | required | ResponseTypehttp://hl7.org/fhir/ValueSet/response-code|4.3.0 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | MessageHeader | 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | MessageHeader | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
dom-r4b | warning | MessageHeader.contained | Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems : ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic) | |
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() |
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:
Other representations of profile: CSV, Excel, Schematron