This page is part of the Specialty Medication Enrollment (v2.0.0: STU2) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Message Structures

Query Message

The Query message requests information from a patient’s health records. It identifies the patient and specifies searches to be performed on the responding system’s server.

It is a message Bundle with:

• an event type equal to query
• a Parameters resource as the focus (see below)
  • Search strings are specified in query-string parameter elements
• a mandatory Patient resource representing the Data Consumer system’s understanding of the patient
• an optional Patient representing the patient in the responder’s system
• optional MedicationRequest, Practitioner, Organization resources to enable the recipient to find the specialty prescription that the Query Request message relates to

See Processing Detail for patient matching and other processing expectations.

Parameter	Cardinality	Type	Description, profile
query-string	1..*	string	Search string. See Search Conventions
requester-patient	1..1	Patient	Patient resource representing the requesting party's (Data Consumer's) understanding of the patient Profile: specialty-rx-patient
responder-patient	0..1	Patient	Patient resource representing the responding party's (Data Source's) understanding of the patient. SHALL be populated when the Data Consumer system has performed a patient match against the Data Source prior to transmitting the Query Message Profile: specialty-rx-patient
medication-request	0..1	MedicationRequest	The associated specialty prescription, which may be included to assist patient matching Profile: specialty-rx-medicationrequest
prescriber	0..1	Practitioner	The prescriber of the associated specialty prescription Profile: specialty-rx-practitioner
pharmacy	0..1	Organization	The pharmacy dispensing the associated specialty prescription Profile: specialty-rx-organization-pharmacy

Query Response Message

The Query Response message returns the requested information from a patient’s health records.

It is a message Bundle with:

• an event type equal to query-response
• a Parameters resource as the focus (see below)
• a mandatory Patient resource representing the requesting party’s understanding of the patient
• a mandatory Patient representing the patient in the responder’s system
• Searchset bundle(s) containing search results

See Processing Detail for patient matching and other processing expectations.

Parameter	Cardinality	Type	Description, profile
requester-patient	1..1	Patient	Patient resource representing the requesting party's (Data Consumer's) understanding of the patient Profile: specialty-rx-patient
responder-patient	1..1	Patient	Patient resource representing the responding party's (Data Source's) understanding of the patient Profile: specialty-rx-patient
search-result	1..*	Bundle	Searchset bundle containing the results from a single search contained in the request Profile: specialty-rx-bundle-search-result

Query Response - Unsolicited Message

The Query Response - Unsolicited message transmits information from a patient’s health record to a stakeholder involved in fulfillment of a specialty medication. This message is not preceded by a request but instead is by a process event–typically sent when the medication is prescribed.

It is a message Bundle with:

• an event type equal to query-response-unsolicited
• a Parameters resource as the focus (see below)
• a mandatory Patient representing the patient in the sender’s system
• mandatory MedicationRequest, Practitioner, Organization resources to enable the recipient to find the specialty prescription that the Query Response - Unsolicited message relates to
• Searchset bundle(s) containing patient data captured as search results

Notes:

• This message is not intended to serve as authorization to dispense the referenced MedicationRequest. Electronic prescriptions are typically transmitted in the US using the NewRx message defined in the NCPDP SCRIPT standard.
• See Processing Detail for patient matching and other processing expectations.

Parameter	Cardinality	Type	Description, profile
source-patient	1..1	Patient	Patient resource representing the Data Source's understanding of the patient Profile: specialty-rx-patient
medication-request	1..1	MedicationRequest	The associated specialty prescription Profile: specialty-rx-medicationrequest
prescriber	1..1	Practitioner	The prescriber of the associated specialty prescription Profile: specialty-rx-practitioner
pharmacy	1..1	Organization	The pharmacy dispensing the associated specialty prescription Profile: specialty-rx-organization-pharmacy
search-result	1..*	Bundle	Searchset bundle containing the results from a single search of patient data Profile: specialty-rx-bundle-search-result