Specialty Medication Enrollment
2.1.0 - CI Build United States of America flag

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

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

Usage:

Formal Views of Profile Content

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

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... eventCoding S1..1CodingCode for the event this message represents or link to event definition
.... system S1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
.... code S1..1codeSymbol in syntax defined by the system
Fixed Value: query
... focus S1..1Reference(Specialty Rx Parameters - Query) {b}The actual content of the message

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1CodingCode 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..1CodingCode 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..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: query
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint Σ1..1urlActual message source address or id
... focus SΣ1..1Reference(Specialty Rx Parameters - Query) {b}The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexampleFixed Value: query

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1CodingCode 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..1CodingCode 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: query
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... destination Σ0..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender Σ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source Σ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus SΣ1..1Reference(Specialty Rx Parameters - Query) {b}The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexampleFixed Value: query
MessageHeader.reasonexampleExampleMessageReasonCodes
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

Differential View

This structure is derived from MessageHeader

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... eventCoding S1..1CodingCode for the event this message represents or link to event definition
.... system S1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
.... code S1..1codeSymbol in syntax defined by the system
Fixed Value: query
... focus S1..1Reference(Specialty Rx Parameters - Query) {b}The actual content of the message

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1CodingCode 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..1CodingCode 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..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: query
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... endpoint Σ1..1urlActual message source address or id
... focus SΣ1..1Reference(Specialty Rx Parameters - Query) {b}The actual content of the message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexampleFixed Value: query

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorMessageHeaderIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorMessageHeaderIf 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-4errorMessageHeaderIf 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-5errorMessageHeaderIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceMessageHeaderA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MessageHeader 0..*MessageHeaderA resource that describes a message that is exchanged between systems
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... Slices for event[x] Σ1..1CodingCode 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..1CodingCode 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..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ1..1uriIdentity of the terminology system
Fixed Value: http://hl7.org/fhir/us/specialty-rx/CodeSystem/specialty-rx-event-type
..... version Σ0..1stringVersion of the system - if relevant
..... code SΣ1..1codeSymbol in syntax defined by the system
Fixed Value: query
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... destination Σ0..*BackboneElementMessage destination application(s)
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... target Σ0..1Reference(Device)Particular delivery destination within the destination
.... endpoint Σ1..1urlActual destination address or id
.... receiver Σ0..1Reference(Practitioner | PractitionerRole | Organization)Intended "real-world" recipient for the data
... sender Σ0..1Reference(Practitioner | PractitionerRole | Organization)Real world sender of the message
... enterer Σ0..1Reference(Practitioner | PractitionerRole)The source of the data entry
... author Σ0..1Reference(Practitioner | PractitionerRole)The source of the decision
... source Σ1..1BackboneElementMessage source application
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... name Σ0..1stringName of system
.... software Σ0..1stringName of software running the system
.... version Σ0..1stringVersion of software running
.... contact Σ0..1ContactPointHuman contact for problems
.... endpoint Σ1..1urlActual message source address or id
... responsible Σ0..1Reference(Practitioner | PractitionerRole | Organization)Final responsibility for event
... reason Σ0..1CodeableConceptCause of event
Binding: ExampleMessageReasonCodes (example): Reason for event occurrence.

... response Σ0..1BackboneElementIf this is a reply to prior message
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... identifier Σ1..1idId of original message
.... code Σ1..1codeok | transient-error | fatal-error
Binding: ResponseType (required): The kind of response to a message.

.... details Σ0..1Reference(OperationOutcome)Specific list of hints/warnings/errors
... focus SΣ1..1Reference(Specialty Rx Parameters - Query) {b}The actual content of the message
... definition Σ0..1canonical(MessageDefinition)Link to the definition for this message

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
MessageHeader.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
MessageHeader.event[x]exampleMessageEvent
MessageHeader.event[x]:eventCodingexampleFixed Value: query
MessageHeader.reasonexampleExampleMessageReasonCodes
MessageHeader.response.coderequiredResponseType

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust 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:

 

Other representations of profile: CSV, Excel, Schematron