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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

Specialty Rx CapabilityStatement - Data Source - RESTful

This CapabilityStatement describes the expected capabilities of a server that is capable of responding to RESTful requests for patient information.

Specialty Rx CapabilityStatement - Data Source - Messaging

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

Specialty Rx CapabilityStatement - Data Consumer - RESTful

This CapabilityStatement describes the expected capabilities of a system that is capable of executing RESTful operations to retrieve patient information from a RESTful FHIR server.

Specialty Rx CapabilityStatement - Data Consumer - Messaging

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

Behavior: Message Definitions

These define the types of messages that can be sent and/or received by systems conforming to this implementation guide.

Specialty Rx MessageDefinition - Error

Message reporting an error that causes premature processing termination of a specialty Rx query response message. References the error event

Specialty Rx MessageDefinition - Query

Message conveying one or more queries for data related to a prescribed specialty medication. References the query event

Specialty Rx MessageDefinition - Query Response

Message conveying the result of one or more queries for data related to a prescribed specialty medication. References the query-response event

Specialty Rx MessageDefinition - Query Response - Unsolicited

Unsolicited message conveying data related to a prescribed specialty medication. References the query-response-unsolicited event

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

Specialty Rx Bundle - Error Message

This profile constrains a Bundle resource for use as an error message in response to a Specialty Rx Query–with an OperationOutcome resource as the bundle’s message focus.

Specialty Rx Bundle - Query Message

This profile constrains a Bundle resource for use as the request message in a Specialty Rx Query process–with a Parameters resource as the bundle’s message focus.

Specialty Rx Bundle - Query Response Message

This profile constrains a Bundle resource for use as the response message in a Specialty Rx Query process–with a Parameters resource as the bundle’s message focus.

Specialty Rx Bundle - Query Response - Unsolicited Message

This profile constrains a Bundle resource for use as the unsolicited query response message in a Specialty Rx Query process–with a Parameters resource as the bundle’s message focus.

Specialty Rx Bundle - Search Result

This profile constrains a Bundle resource to carry the query results from a Specialty Rx Query

Specialty Rx Coverage

This profile constrains the Coverage resource for carrying insurance coverage information in the specialty medication enrollment process

Specialty Rx Medication Request

This profile tailors the MedicationRequest resource to support specialty medication dispensing and enrollment in related programs.

Specialty Rx MessageHeader - Query

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

Specialty Rx MessageHeader - Query Response

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

Specialty Rx MessageHeader - Error

This profile constrains a MessageHeader resource for use in a Specialty Rx error bundle. An OperationOutcome resource is the focus.

Specialty Rx MessageHeader - Query Response - Unsolicited

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

Specialty Rx Organization - Pharmacy

Defines further constraints on the US Core Organization resource for use in specialty medication dispensing and enrollment in related programs.

Specialty Rx Parameters - Query

This profile tailors the Parameters resource to convey Specialty Rx Query inputs.

Specialty Rx Parameters - Query Response

This profile tailors the Parameters resource to convey Specialty Rx Query outputs.

Specialty Rx Parameters - Query Response - Unsolicited

This profile tailors the Parameters resource to convey Specialty Rx Query Response - Unsolicited content.

Specialty Rx Patient

This profile tailors the Patient resource for carrying the patient information needed to support specialty medication dispensing and enrollment in related programs.

Specialty Rx Practitioner

This profile tailors the Practitioner resource to support specialty medication dispensing and enrollment in related programs.

Specialty Rx Task - SMART Launch

This profile defines Task content enabling a pharmacy or other external party to prompt clinic staff to launch a SMART app and answer prescription-related questions.

Specialty Rx Consent

This profile constrains a Consent resource to convey consents and authorizations associated with fulfillment of a specialty medication or other product

Specialty Rx Consent Requested

This profile constrains a Consent resource to convey a request for consents and authorizations associated with fulfillment of a specialty medication or other product. This Consent includes an attachment containing the enrollment consent form applicable to the prescribed product

Specialty Rx Task - Consent Request

This profile defines use of the Task resource to request that consent or authorization associated with prescribed product be obtained and made available to the requesting system.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Specialty Rx ValueSet - Event Type

This value set contains event types used in Specialty Rx message headers.

Specialty Rx ValueSet - Task Type

This value set contains task types used in the Specialty Rx Task profiles.

Specialty Rx ValueSet - Task Input Type

This value set contains task input types used in the Specialty Rx Task profiles.

Specialty Rx ValueSet - Task Output Type

This value set contains task output types used in the Specialty Rx Task profiles.

Specialty Rx ValueSet - Consent Status

This value set contains a subset of consent statuses applicable to the Specialty Rx Consent profile, which captures the consents provided by a patient to support fulfillment of a specialty medication or other specialty product

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

Specialty Rx CodeSystem - Event Type

This code system defines event types used in Specialty Rx message headers

Specialty Rx CodeSystem - Task Characteristic

This code system defines task types, task input types, task output types and task identifier types used in the Specialty Rx Task profiles

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Specialty Rx Coverage 1

Example of a Specialty Rx Coverage resource containing pharmacy benefit plan information.

Specialty Rx Error 1

Example data error message (temporary system error)

Specialty Rx MedicationRequest 1

An example MedicationRequest illustrating elements required in the Specialty Medication Enrollment profile. This profile is used in Specialty Rx messages to identify the prescription prompting the information exchange.

Specialty Rx Organization - Pharmacy 1

Example Organization resource representing a pharmacy

Specialty Rx Organization - Pharmacy 2 - Unknown Telecom

Example Organization resource representing a pharmacy - where telecom is unknown

Specialty Rx Patient 1

An example Patient illustrating required elements in the Specialty Medication Enrollment profile

Specialty Rx Practitioner 1

An example Practitioner illustrating required elements in the Specialty Medication Enrollment profile

Specialty Rx Query 1

Example data query message

Specialty Rx Query Response 1

Example data query response message (single search)

Specialty Rx Query Response 2

Example data query response message (multiple searches)

Specialty Rx Query Response 3 with operation outcome

Example data query response message containing an error

Search Response 1 with _included Medication Resource

Example searchset bundle containing an included Medication resource .

Search Response 2 with _revincluded Provenance Resource

Example searchset bundle containing a _revinclude Provenance resource .

Specialty Rx Query Response - Unsolicited 1

Example unsolicited query response message.

Specialty Rx Task - SMART Launch 1

Example of a Task that directs the user to launch a specified SMART app to complete a questionnaire

Specialty Rx Task - SMART Launch 2 with IDs

Example of a Task that directs the user to launch a specified SMART app to complete a questionnaire. Requester, owner and focus are identifiers.

Specialty Rx Task - Consent 1

Example of a completed consent containing a PDF of the signed consent form.

Specialty Rx Consent Requested 1

Example of a proposed consent containing a PDF of the empty product-specific consent form to be completed by the patient.

Specialty Rx Task - Consent Request 1

Example of a task requesting that the practice obtain consent from the patient using the referenced consent form.

Specialty Rx Task - Consent Request 2 - Completed

Example of a completed consent task containing the finished consent form.

Specialty Rx Task - Consent Request Contained

Example of a consent request task with a contained Consent resource holding the emmpty consent form.

US Core Organization - Clinic 1 - Acme Clinic

Example US Core organization.