This page is part of the Consumer Real-time Pharmacy Benefit Check (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
This profile constrains a MessageHeader resource for use in a Real-time Pharmacy Benefit Check (RTPBC) request bundle
The official URL for this profile is:
http://hl7.org/fhir/us/carin-rtpbc/StructureDefinition/rtpbc-request-messageheader
This profile constrains the MessageHeader resource for use in a real-time pharmacy benefit check (RTPBC) request bundle.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MessageHeader
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 | |
eventCoding | S | 1..1 | Coding | Code for the event this message represents or link to event definition Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/CodeSystem/rtpbc-event-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rtpbc-request | |
display | 1..1 | string | Representation defined by the system Fixed Value: RTPBC Request | |
focus:rtpbc-request | S | 1..1 | Reference(RTPBC Request Using Claim) {b} | The actual content of the message |
definition | S | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/MessageDefinition/rtpbc-request |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | I | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
event[x] | ΣI | 1..1 | (Slice Definition) | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example) |
event[x]:eventCoding | SΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: MessageEvent (example) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/CodeSystem/rtpbc-event-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rtpbc-request | |
display | 1..1 | string | Representation defined by the system Fixed Value: RTPBC Request | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
destination | ΣI | 0..* | BackboneElement | Message destination application(s) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | ΣI | 0..1 | string | Name of system |
target | ΣI | 0..1 | Reference(Device) | Particular delivery destination within the destination |
endpoint | ΣI | 1..1 | url | Actual destination address or id |
receiver | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data |
sender | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
enterer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
author | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
source | ΣI | 1..1 | BackboneElement | Message source application |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | ΣI | 0..1 | string | Name of system |
software | ΣI | 0..1 | string | Name of software running the system |
version | ΣI | 0..1 | string | Version of software running |
contact | ΣI | 0..1 | ContactPoint | Human contact for problems |
endpoint | ΣI | 1..1 | url | Actual message source address or id |
responsible | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
reason | ΣI | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example) |
response | ΣI | 0..1 | BackboneElement | If this is a reply to prior message |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | ΣI | 1..1 | id | Id of original message |
code | ΣI | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required) |
details | ΣI | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
focus:rtpbc-request | SΣI | 1..1 | Reference(RTPBC Request Using Claim) {b} | The actual content of the message |
definition | SΣI | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/MessageDefinition/rtpbc-request |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | I | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems |
event[x]:eventCoding | ΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: MessageEvent (example) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/CodeSystem/rtpbc-event-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rtpbc-request | |
display | 1..1 | string | Representation defined by the system Fixed Value: RTPBC Request | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
focus:rtpbc-request | ΣI | 1..1 | Reference(RTPBC Request Using Claim) {b} | The actual content of the message |
definition | ΣI | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/MessageDefinition/rtpbc-request |
Documentation for this format |
This structure is derived from MessageHeader
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 | |
eventCoding | S | 1..1 | Coding | Code for the event this message represents or link to event definition Required Pattern: At least the following |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/CodeSystem/rtpbc-event-type | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rtpbc-request | |
display | 1..1 | string | Representation defined by the system Fixed Value: RTPBC Request | |
focus:rtpbc-request | S | 1..1 | Reference(RTPBC Request Using Claim) {b} | The actual content of the message |
definition | S | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/MessageDefinition/rtpbc-request |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
MessageHeader | I | 0..* | MessageHeader | A resource that describes a message that is exchanged between systems |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | ΣI | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
contained | 0..* | Resource | Contained, inline Resources | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
event[x] | ΣI | 1..1 | (Slice Definition) | Code for the event this message represents or link to event definition Slice: Unordered, Closed by type:$this Binding: MessageEvent (example) |
event[x]:eventCoding | SΣI | 1..1 | Coding | Code for the event this message represents or link to event definition Binding: MessageEvent (example) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/CodeSystem/rtpbc-event-type | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rtpbc-request | |
display | 1..1 | string | Representation defined by the system Fixed Value: RTPBC Request | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
destination | ΣI | 0..* | BackboneElement | Message destination application(s) |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | ΣI | 0..1 | string | Name of system |
target | ΣI | 0..1 | Reference(Device) | Particular delivery destination within the destination |
endpoint | ΣI | 1..1 | url | Actual destination address or id |
receiver | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Intended "real-world" recipient for the data |
sender | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message |
enterer | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the data entry |
author | ΣI | 0..1 | Reference(Practitioner | PractitionerRole) | The source of the decision |
source | ΣI | 1..1 | BackboneElement | Message source application |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | ΣI | 0..1 | string | Name of system |
software | ΣI | 0..1 | string | Name of software running the system |
version | ΣI | 0..1 | string | Version of software running |
contact | ΣI | 0..1 | ContactPoint | Human contact for problems |
endpoint | ΣI | 1..1 | url | Actual message source address or id |
responsible | ΣI | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Final responsibility for event |
reason | ΣI | 0..1 | CodeableConcept | Cause of event Binding: ExampleMessageReasonCodes (example) |
response | ΣI | 0..1 | BackboneElement | If this is a reply to prior message |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | I | 0..* | Extension | Additional content defined by implementations |
modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
identifier | ΣI | 1..1 | id | Id of original message |
code | ΣI | 1..1 | code | ok | transient-error | fatal-error Binding: ResponseType (required) |
details | ΣI | 0..1 | Reference(OperationOutcome) | Specific list of hints/warnings/errors |
focus:rtpbc-request | SΣI | 1..1 | Reference(RTPBC Request Using Claim) {b} | The actual content of the message |
definition | SΣI | 1..1 | canonical(MessageDefinition) | Link to the definition for this message Fixed Value: http://hl7.org/fhir/us/carin-rtpbc/MessageDefinition/rtpbc-request |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
MessageHeader.language | preferred | CommonLanguages Max Binding: AllLanguages |
MessageHeader.event[x] | example | MessageEvent |
MessageHeader.event[x]:eventCoding | example | Pattern: rtpbc-request("RTPBC Request") |
MessageHeader.reason | example | ExampleMessageReasonCodes |
MessageHeader.response.code | required | ResponseType |
Id | Path | Details | Requirements |
dom-2 | MessageHeader | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 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 | 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 | MessageHeader | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | MessageHeader | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | MessageHeader.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MessageHeader.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MessageHeader.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MessageHeader.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MessageHeader.event[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.event[x]:eventCoding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.destination | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.destination.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MessageHeader.destination.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MessageHeader.destination.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MessageHeader.destination.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MessageHeader.destination.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.destination.target | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.destination.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.destination.receiver | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.sender | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.enterer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.author | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.source | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.source.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MessageHeader.source.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MessageHeader.source.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MessageHeader.source.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MessageHeader.source.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.source.software | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.source.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.source.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.source.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.responsible | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.reason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.response | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.response.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MessageHeader.response.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MessageHeader.response.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | MessageHeader.response.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | MessageHeader.response.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.response.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.response.details | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.focus:rtpbc-request | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | MessageHeader.definition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |