TRxHub IG
0.1.0 - ci-build

TRxHub IG - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. 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: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

TRxHub ServiceRequest update status

OperationDefinition to update a ServiceRequest Status

TRxHub ePrescription Custom

One-off operation that accepts an ePrescription and a patient email address, and triggers the full prescription flow (patient creation, registration, and ordering) in a single request.

Structures: Resource Profiles

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

TRxHub Coverage

Coverage for TRxHub

TRxHub MedicationDispense

Dispensation of an ordered MedicationRequest

TRxHub MedicationRequest

Represents a medication from a prescription

TRxHub Message Bundle

Message Bundle for TRxHub. Not part of the FHIR API

TRxHub Message Header

Message Header for TRxHub. Not part of the FHIR API

TRxHub Patient

Patient for TRxHub

TRxHub Practitioner

A Practitioner for the TRxHub

TRxHub ServiceRequest

ServiceRequest for TRxHub

TRxHub Transaction Bundle

Transaction Bundle for TRxHub. Lets a client submit several operations in a single request, processed atomically.

TRxHub ePrescription DocumentReference

DocumentReference that represents an ePrescription

Structures: Extension Definitions

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

Indication Code

Indication code for insurance and billing purposes. For more details see Indication Code in CH-Core

Medication Substitution Preference

Indicates whether the patient allows medication substitution.

Shipment Tracking URL

Link to the carrier's tracking page for the shipment of the dispense

TRxHub Coverage Payor Role

Indicates the role of a payor entry within a TRxHub Coverage resource

Terminology: Value Sets

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

TRxHub Coverage Payor Role ValueSet

Allowed roles for a payor entry in TRxHub Coverage

TRxHub Coverage Status ValueSet

Restricts coverage status to the codes supported by TRxHub

TRxHub Coverage Type ValueSet

Allowed types for TRxHub Coverage

TRxHub MedicationDispense Status Reason ValueSet

Allowed status reasons for TRxHub MedicationDispense

TRxHub MedicationDispense Status ValueSet

Restricts medicationdispense-status to the codes supported by TRxHub

TRxHub MedicationDispense Type ValueSet

Allowed Types for TRxHub MedicationDispense

TRxHub MessageHeader Event ValueSet

Allowed events for TRxHub MessageHeader. Not part of the FHIR API

TRxHub Patient Communication Languages ValueSet

Allowed Language Codes for TRxHub Patient Communication

TRxHub ServiceRequest Category ValueSet

Allowed categories for TRxHub ServiceRequests

TRxHub ServiceRequest Code ValueSet

Allowed codes for TRxHub ServiceRequests

TRxHub ServiceRequest Status ValueSet

Restricts request-status to the codes supported by TRxHub

TRxHub ServiceRequest Update Status ValueSet

Restricts request-status to the codes valid for the update-status operation

Terminology: Code Systems

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

TRxHub Coverage Payor Role

Defines the role of the payor in coverage

TRxHub Coverage Type

Represents coverage Type similar to R5 Coverage.kind

TRxHub MedicationDispense Status Reason

Reasons for MedicationDispenseStatus

TRxHub MedicationDispense Type

Types for TRxHub MedicationDispense

TRxHub MessageHeader Event

Events for TRxHub MessageHeader. Not part of the FHIR API

TRxHub ServiceRequest Category

Categories for TRxHub ServiceRequests

TRxHub ServiceRequest Code

Codes for TRxHub ServiceRequests

Example: Example Instances

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

TRxHub Coverage Example Insurance

Example of TRxHub Coverage with Insurance type

TRxHub Coverage Example Self-Pay

Example of TRxHub Coverage with Self-Pay type

TRxHub MedicationDispense Example Completed

Example of a TRxHub MedicationDispense with status completed

TRxHub MedicationDispense Example Declined

Example of a TRxHub MedicationDispense with status declined

TRxHub MedicationRequest Example

Example of a TRxHub MedicationRequest

TRxHub Patient Example

Example instance of TRxHub Patient

TRxHub Practitioner Example

Example of TRxHub Practitioner

TRxHub ServiceRequest Example Order Medication

Example of a TRxHub ServiceRequest with category order-medication

TRxHub ServiceRequest Example Register Normal

Example of a TRxHub ServiceRequest with category register-prescription and code register-normal. This flow is for internal ERP use only and is not available to external clients.

TRxHub Transaction Bundle Example

Transaction bundle creating a Patient and Coverage

TRxHub Transaction Bundle Example Coverage

Coverage referencing the Patient created earlier in the same transaction bundle via its bundle-local urn:uuid