Specialty Medication Enrollment
2.1.0 - CI Build

Specialty Medication Enrollment, published by HL7 International - Pharmacy. This is not an authorized publication; it is the continuous build for version 2.1.0). This version is based on the current content of https://github.com/HL7/fhir-specialty-rx/ and changes regularly. See the Directory of published versions

## Resource Profile: Specialty Rx MessageHeader - Query

Official URL: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-messageheader-query | Version: 2.1.0
Active as of 2020-05-01 | Computable Name: SpecialtyRxMessageHeaderQuery

This profile constrains a MessageHeader resource for use in a Specialty Rx query data bundle. A Parameters resource is the focus.

Important elements in this profile:

- MessageHeader.eventCoding.code
  - The code system, `specialty-rx-event-type` and value, `query` identify the message as a Specialty Rx Query
- MessageHeader.focus
  - This element references a Parameters resource conforming to the Specialty Rx Parameters - Query profile

Example. This profile is illustrated in the following full message example:

- Specialty Rx Query 1

Usage:

- Use this Resource Profile: Specialty Rx Bundle - Query Message

### Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

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
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: query
focus | S | 1..1 | Reference(Specialty Rx Parameters - Query) {b} | 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
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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 | S Σ | 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 | S Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
code | S Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: query
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 | S Σ | 1..1 | Reference(Specialty Rx Parameters - Query) {b} | The actual content of the message
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.event[x] | example | MessageEvent
MessageHeader.event[x]:eventCoding | example | Fixed Value: query

#### Constraints

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 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 | 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() |

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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
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 | S Σ | 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 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: query
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 | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message
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 | Σ | 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 | Σ | 0..1 | ContactPoint | Human contact for problems
endpoint | Σ | 1..1 | url | Actual message source address or id
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 | S Σ | 1..1 | Reference(Specialty Rx Parameters - Query) {b} | The actual content of 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
Additional Bindings | Purpose
AllLanguages | Max Binding
MessageHeader.event[x] | example | MessageEvent
MessageHeader.event[x]:eventCoding | example | Fixed Value: query
MessageHeader.reason | example | ExampleMessageReasonCodes
MessageHeader.response.code | required | ResponseType

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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: 4 elements
Must-Support: 4 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

- Specialty Rx Parameters - Query (http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-parameters-query)

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
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
code | S | 1..1 | code | Symbol in syntax defined by the system Fixed Value: query
focus | S | 1..1 | Reference(Specialty Rx Parameters - Query) {b} | 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
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
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 | S Σ | 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 | S Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
code | S Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: query
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 | S Σ | 1..1 | Reference(Specialty Rx Parameters - Query) {b} | The actual content of the message
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.event[x] | example | MessageEvent
MessageHeader.event[x]:eventCoding | example | Fixed Value: query

#### Constraints

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 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 | 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() |

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): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
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 | S Σ | 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 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
system | S Σ | 1..1 | uri | Identity of the terminology system Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: query
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 | Σ | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Real world sender of the message
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 | Σ | 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 | Σ | 0..1 | ContactPoint | Human contact for problems
endpoint | Σ | 1..1 | url | Actual message source address or id
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 | S Σ | 1..1 | Reference(Specialty Rx Parameters - Query) {b} | The actual content of 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
Additional Bindings | Purpose
AllLanguages | Max Binding
MessageHeader.event[x] | example | MessageEvent
MessageHeader.event[x]:eventCoding | example | Fixed Value: query
MessageHeader.reason | example | ExampleMessageReasonCodes
MessageHeader.response.code | required | ResponseType

#### Constraints

Id | Grade | Path(s) | Details | Requirements
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: 4 elements
Must-Support: 4 elements
Fixed Value: 2 elements

Structures

This structure refers to these other structures:

- Specialty Rx Parameters - Query (http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-parameters-query)

Other representations of profile: CSV, Excel, Schematron