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

CapabilityStatement: Specialty Rx CapabilityStatement - Data Consumer - Messaging

Official URL: http://hl7.org/fhir/us/specialty-rx/CapabilityStatement/specialty-rx-data-consumer-messaging Version: 2.1.0
Active as of 2022-07-01 Computable Name: SpecialtyRxDataConsumerMessaging

This CapabilityStatement describes the expected capabilities of a system that is capable of retrieving patient information using Specialty Rx Query messaging.

FHIR RESTful Capabilities

Specialty Rx Data Consumer SHALL:

  1. Support the Unsolicited workflow defined in this Guide and respond to the $process-message operation carrying a Specialty Rx Query Response - Unsolicited.
  2. Support the JSON source format.
  3. Declare a CapabilityStatement identifying the profiles supported.
  4. Follow US Core search requirements and guidance when performing searches associated with this IG.

Specialty Rx Data Consumer SHOULD:

  1. Support the XML source format.
  2. Identify the Specialty Rx profiles supported as part of the FHIR meta.profile attribute for each applicable instance.

The Specialty Rx Data Consumer MAY

  1. Support the Solicited workflow defined in this Guide, including the Specialty Rx Query, Specialty Rx Query Response, and Specialty Rx Error messages.
  2. Support the Patient/$match operation.
  3. Support the Task / SMART application launch capability specified in the guide.
  4. Support the Task / Consent Request capability specified in the guide.


  1. For general security considerations refer to FHIR Security and Privacy Considerations.
  2. For additional security guidance, refer to the core FHIR Security guidance page.
  3. A server SHALL reject any unauthorized requests by returning an HTTP 401 unauthorized response code.


  • AllergyIntolerance, Condition, Coverage, DocumentReference, MedicationRequest and Observation actions referenced below are executed in the context of message processing.

  • Task interactions reference below are RESTful.

  • OperationOutcome interactions referenced below are within both messaging and RESTful actions.

Resource Type Profile Read Search Update Create
SHOULD AllergyIntolerance http://hl7.org/fhir/us/core/StructureDefinition/us-core-allergyintolerance y y
SHOULD Condition http://hl7.org/fhir/us/core/StructureDefinition/us-core-condition y y
SHOULD Coverage http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-coverage y y
SHOULD DocumentReference http://hl7.org/fhir/us/core/StructureDefinition/us-core-documentreference y y
SHOULD MedicationRequest Search results:

Identifying the prescribed medication in messaging:
y y
SHOULD Observation http://hl7.org/fhir/us/core/StructureDefinition/us-core-observation-lab y y
SHALL OperationOutcome http://hl7.org/fhir/StructureDefinition/OperationOutcome y y
MAY Task http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-task-smart-launch y y y
MAY Task http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-task-consent-request y y y
MAY Consent http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent y
MAY Consent http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-consent-requested y


Data Consumer systems SHALL follow US Core search requirements and guidance when performing searches associated with this guide. See the Search Conventions section.


Mode Message Type Message Definition Message Bundle
SHALL Receiver Specialty Rx Query Response - Unsolicited http://hl7.org/fhir/us/specialty-rx/MessageDefinition/specialty-rx-query-response-unsolicited http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-query-response-unsolicited
SHALL Receiver and Sender Specialty Rx Error http://hl7.org/fhir/us/specialty-rx/MessageDefinition/specialty-rx-error http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-error
MAY Sender Specialty Rx Query http://hl7.org/fhir/us/specialty-rx/MessageDefinition/specialty-rx-query http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-query
MAY Receiver Specialty Rx Query Response http://hl7.org/fhir/us/specialty-rx/MessageDefinition/specialty-rx-query-response http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-bundle-query-response

Raw OpenAPI-Swagger Definition file | Download