Specialty Medication Enrollment
0.1.0 - STU1 Ballot

Publication Build: This will be filled in by the publication tooling

## Resource Profile: Specialty Rx MessageHeader - Query Response

Defining URL: | http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-messageheader-query-response
Version: | 0.1.0
Name: | SpecialtyRxMessageHeaderQueryResponse
Title: | Specialty Rx Query Response MessageHeader
Status: | Active as of 2020-05-01T00:00:00-00:00
Definition: | This profile constrains a MessageHeader resource for use in a Specialty Rx query response bundle. A Parameters resource is the focus.
Publisher: | HL7 International - Pharmacy
Source Resource: | XML / JSON / Turtle

The official URL for this profile is:

    http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-messageheader-query-response

### Formal Views of Profile Content

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

- Text Summary
- Differential Table
- Snapshot Table
- Snapshot Table (Must Support)
- All

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:

- http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-parameters-query-response

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-response
focus:parameters | S | 1..1 | Reference(Specialty Rx Parameters - Query Response) {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
id | Σ | 0..1 | string | 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) Max Binding: AllLanguages: A human language.
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
event[x] | Σ | 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): 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-response
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:parameters | S Σ | 1..1 | Reference(Specialty Rx Parameters - Query Response) {b} | The actual content of the message
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this 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
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 Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
code | Σ | 1..1 | code | Symbol in syntax defined by the system Fixed Value: query-response
focus:parameters | Σ | 1..1 | Reference(Specialty Rx Parameters - Query Response) {b} | The actual content of the message
Documentation for this format

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:

- http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-parameters-query-response

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-response
focus:parameters | S | 1..1 | Reference(Specialty Rx Parameters - Query Response) {b} | The actual content of the message
Documentation for this format

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 | string | 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) Max Binding: AllLanguages: A human language.
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
event[x] | Σ | 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): 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-response
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:parameters | S Σ | 1..1 | Reference(Specialty Rx Parameters - Query Response) {b} | The actual content of the message
definition | Σ | 0..1 | canonical(MessageDefinition) | Link to the definition for this message
Documentation for this format

Other representations of profile: Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
MessageHeader.language | preferred | CommonLanguages Max Binding: AllLanguages
MessageHeader.event[x] | example | MessageEvent
MessageHeader.event[x]:eventCoding | example | Fixed Value: query-response
MessageHeader.reason | example | ExampleMessageReasonCodes
MessageHeader.response.code | required | ResponseType

#### Constraints

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.event[x]:eventCoding.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ext-1 | MessageHeader.event[x]:eventCoding.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
ele-1 | MessageHeader.event[x]:eventCoding.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | MessageHeader.event[x]:eventCoding.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | MessageHeader.event[x]:eventCoding.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | MessageHeader.event[x]:eventCoding.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
ele-1 | MessageHeader.event[x]:eventCoding.userSelected | 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:parameters | 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()) |