docs.jsonld
type: ApiDocumentation
title: Impetus One API
description: Prescription Management Platform API - Healthcare Prescribing Solution
entrypoint: /api
supported class: Error
supported class: ConstraintViolation
supported class: Appointment
supported class: BillingPeriod
supported class: Invoice
supported class: InvoiceLineItem
supported class: Clinic
supported class: Provider
supported class: EcommerceOrder
supported class: SkuMapping
supported class: Encounter
supported class: Medication
supported class: BusinessUnit
supported class: Organization
supported class: Patient
supported class: PatientBiometrics
supported class: PatientChartNote
supported class: TreatmentIndication
supported class: Pharmacy
supported class: Prescription
supported class: PrescriptionAuditLog
supported class: PrescriptionDraft
supported class: ProductSku
supported class: QueueItem
supported class: Entrypoint
supported class: ConstraintViolationList

Error
type: Class
title: Error
supported property: SupportedProperty
  property: Error/id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/title
  title: title
  required: false
  readable: true
  writeable: false
  description: A short, human-readable summary of the problem.
supported property: SupportedProperty
  property: Error/detail
  title: detail
  required: false
  readable: true
  writeable: false
  description: A human-readable explanation specific to this occurrence of the problem.
supported property: SupportedProperty
  property: Error/instance
  title: instance
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
supported property: SupportedProperty
  property: Error/type
  title: type
  required: false
  readable: true
  writeable: false
  description: A URI reference that identifies the problem type
supported property: SupportedProperty
  property: Error/meta
  title: meta
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Error/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/message
  title: message
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/code
  title: code
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Error/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Error resource.
  method: GET
  returns: Error
  title: getError
description: A representation of common errors.
subclass of: Error

Error/id
type: Property
domain: Error
the hydra core vocabulary: id
range: string

Error/title
type: Property
domain: Error
the hydra core vocabulary: title
range: string

Error/detail
type: Property
domain: Error
the hydra core vocabulary: detail
range: string

Error/instance
type: Property
domain: Error
the hydra core vocabulary: instance
range: string

Error/type
type: Property
domain: Error
the hydra core vocabulary: type
range: string

Error/meta
type: Property
domain: Error
the hydra core vocabulary: meta

Error/source
type: Property
domain: Error
the hydra core vocabulary: source

Error/description
type: Property
domain: Error
the hydra core vocabulary: description
range: string

Error/trace
type: Property
domain: Error
the hydra core vocabulary: trace

Error/message
type: Property
domain: Error
the hydra core vocabulary: message
range: string

Error/code
type: Property
domain: Error
the hydra core vocabulary: code
range: integer

Error/file
type: Property
domain: Error
the hydra core vocabulary: file
range: string

Error/line
type: Property
domain: Error
the hydra core vocabulary: line
range: integer

ConstraintViolation
type: Class
title: ConstraintViolation
supported property: SupportedProperty
  property: ConstraintViolation/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/errorTitle
  title: errorTitle
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/violations
  title: violations
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/detail
  title: detail
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ConstraintViolation/file
  title: file
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/line
  title: line
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/description
  title: description
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/instance
  title: instance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/statusCode
  title: statusCode
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/headers
  title: headers
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/trace
  title: trace
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ConstraintViolation/previous
  title: previous
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
supported operation: Operation
  type: FindAction
  description: Retrieves a ConstraintViolation resource.
  method: GET
  returns: ConstraintViolation
  title: getConstraintViolation
description: Unprocessable entity
subclass of: Error

ConstraintViolation/status
type: Property
domain: ConstraintViolation
the hydra core vocabulary: status
range: integer

ConstraintViolation/errorTitle
type: Property
domain: ConstraintViolation
the hydra core vocabulary: errorTitle
range: string

ConstraintViolation/violations
type: Property
domain: ConstraintViolation
the hydra core vocabulary: violations
range: ConstraintViolationList

ConstraintViolation/detail
type: Property
domain: ConstraintViolation
the hydra core vocabulary: detail
range: string

ConstraintViolation/message
type: Property
domain: ConstraintViolation
the hydra core vocabulary: message
range: string

ConstraintViolation/code
type: Property
domain: ConstraintViolation
the hydra core vocabulary: code
range: string
range: integer

ConstraintViolation/file
type: Property
domain: ConstraintViolation
the hydra core vocabulary: file
range: string

ConstraintViolation/line
type: Property
domain: ConstraintViolation
the hydra core vocabulary: line
range: integer

ConstraintViolation/description
type: Property
domain: ConstraintViolation
the hydra core vocabulary: description
range: string

ConstraintViolation/type
type: Property
domain: ConstraintViolation
the hydra core vocabulary: type
range: string

ConstraintViolation/title
type: Property
domain: ConstraintViolation
the hydra core vocabulary: title
range: string

ConstraintViolation/instance
type: Property
domain: ConstraintViolation
the hydra core vocabulary: instance
range: string

ConstraintViolation/statusCode
type: Property
domain: ConstraintViolation
the hydra core vocabulary: statusCode
range: integer

ConstraintViolation/headers
type: Property
domain: ConstraintViolation
the hydra core vocabulary: headers

ConstraintViolation/trace
type: Property
domain: ConstraintViolation
the hydra core vocabulary: trace

ConstraintViolation/previous
type: Property
domain: ConstraintViolation
the hydra core vocabulary: previous
range: integer

Appointment
type: Class
title: Appointment
supported property: SupportedProperty
  property: Appointment/encounter
  title: encounter
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/durationMinutes
  title: durationMinutes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/reason
  title: reason
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/rrule
  title: rrule
  required: false
  readable: true
  writeable: true
  description: RFC 5545 RRULE for recurring appointments
supported property: SupportedProperty
  property: Appointment/videoProvider
  title: videoProvider
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/videoRoomId
  title: videoRoomId
  required: false
  readable: true
  writeable: false
  description: Video room ID from provider (Daily.co room name, Zoom meeting ID, etc.)
supported property: SupportedProperty
  property: Appointment/videoUrl
  title: videoUrl
  required: false
  readable: true
  writeable: false
  description: Full video meeting URL
supported property: SupportedProperty
  property: Appointment/confirmedAt
  title: confirmedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/checkedInAt
  title: checkedInAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/startedAt
  title: startedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/completedAt
  title: completedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/cancelledAt
  title: cancelledAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/patientNotes
  title: patientNotes
  required: false
  readable: true
  writeable: true
  description: Patient's reason/notes for booking
supported property: SupportedProperty
  property: Appointment/providerNotes
  title: providerNotes
  required: false
  readable: true
  writeable: false
  description: Provider's internal notes
supported property: SupportedProperty
  property: Appointment/cancellationReason
  title: cancellationReason
  required: false
  readable: true
  writeable: false
  description: Cancellation reason if cancelled
supported property: SupportedProperty
  property: Appointment/cancelledBy
  title: cancelledBy
  required: false
  readable: true
  writeable: false
  description: Who cancelled: 'patient', 'provider', 'system'
supported property: SupportedProperty
  property: Appointment/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Appointment/patient
  title: patient
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/provider
  title: provider
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/clinic
  title: clinic
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/scheduledAt
  title: scheduledAt
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Appointment/type
  title: type
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Appointment resource.
  method: GET
  returns: Appointment
  title: getAppointment
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Appointment resource.
  expects: Appointment
  method: PUT
  returns: Appointment
  title: putAppointment
description: Appointment entity for scheduling patient visits. Supports video telehealth, in-person, and phone appointments. Integrates with video providers (Daily.co, Google Meet, Zoom).

Appointment/encounter
type: Link
domain: Appointment
the hydra core vocabulary: encounter
max cardinality: 1
range: Encounter

Appointment/durationMinutes
type: Property
domain: Appointment
the hydra core vocabulary: durationMinutes
range: integer

Appointment/status
type: Property
domain: Appointment
the hydra core vocabulary: status

Appointment/reason
type: Property
domain: Appointment
the hydra core vocabulary: reason

Appointment/rrule
type: Property
domain: Appointment
the hydra core vocabulary: rrule
range: string

Appointment/videoProvider
type: Property
domain: Appointment
the hydra core vocabulary: videoProvider

Appointment/videoRoomId
type: Property
domain: Appointment
the hydra core vocabulary: videoRoomId
range: string

Appointment/videoUrl
type: Property
domain: Appointment
the hydra core vocabulary: videoUrl
range: string

Appointment/confirmedAt
type: Property
domain: Appointment
the hydra core vocabulary: confirmedAt
range: dateTime

Appointment/checkedInAt
type: Property
domain: Appointment
the hydra core vocabulary: checkedInAt
range: dateTime

Appointment/startedAt
type: Property
domain: Appointment
the hydra core vocabulary: startedAt
range: dateTime

Appointment/completedAt
type: Property
domain: Appointment
the hydra core vocabulary: completedAt
range: dateTime

Appointment/cancelledAt
type: Property
domain: Appointment
the hydra core vocabulary: cancelledAt
range: dateTime

Appointment/patientNotes
type: Property
domain: Appointment
the hydra core vocabulary: patientNotes
range: string

Appointment/providerNotes
type: Property
domain: Appointment
the hydra core vocabulary: providerNotes
range: string

Appointment/cancellationReason
type: Property
domain: Appointment
the hydra core vocabulary: cancellationReason
range: string

Appointment/cancelledBy
type: Property
domain: Appointment
the hydra core vocabulary: cancelledBy
range: string

Appointment/createdAt
type: Property
domain: Appointment
the hydra core vocabulary: createdAt
range: dateTime

Appointment/updatedAt
type: Property
domain: Appointment
the hydra core vocabulary: updatedAt
range: dateTime

Appointment/patient
type: Link
domain: Appointment
the hydra core vocabulary: patient
max cardinality: 1
range: Patient

Appointment/provider
type: Link
domain: Appointment
the hydra core vocabulary: provider
max cardinality: 1
range: Provider

Appointment/clinic
type: Link
domain: Appointment
the hydra core vocabulary: clinic
max cardinality: 1
range: Clinic

Appointment/scheduledAt
type: Property
domain: Appointment
the hydra core vocabulary: scheduledAt
range: dateTime

Appointment/type
type: Property
domain: Appointment
the hydra core vocabulary: type

BillingPeriod
type: Class
title: BillingPeriod
supported property: SupportedProperty
  property: BillingPeriod/frequency
  title: frequency
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: BillingPeriod/name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: BillingPeriod/configuration
  title: configuration
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a BillingPeriod resource.
  method: GET
  returns: BillingPeriod
  title: getBillingPeriod
supported operation: Operation
  type: ReplaceAction
  description: Replaces the BillingPeriod resource.
  expects: BillingPeriod
  method: PUT
  returns: BillingPeriod
  title: putBillingPeriod

BillingPeriod/frequency
type: Property
domain: BillingPeriod
the hydra core vocabulary: frequency
range: string

BillingPeriod/name
type: Property
domain: BillingPeriod
the hydra core vocabulary: name
range: string

BillingPeriod/configuration
type: Property
domain: BillingPeriod
the hydra core vocabulary: configuration

Invoice
type: Class
title: Invoice
supported property: SupportedProperty
  property: Invoice/referenceNumber
  title: referenceNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/totalAmountCents
  title: totalAmountCents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/periodStart
  title: periodStart
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/periodEnd
  title: periodEnd
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Invoice/paidAt
  title: paidAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/paymentTransactionId
  title: paymentTransactionId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/organization
  title: organization
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/businessUnit
  title: businessUnit
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/clinic
  title: clinic
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/provider
  title: provider
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/patient
  title: patient
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Invoice/lineItems
  title: lineItems
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Invoice resource.
  method: GET
  returns: Invoice
  title: getInvoice

Invoice/referenceNumber
type: Property
domain: Invoice
the hydra core vocabulary: referenceNumber
range: string

Invoice/status
type: Property
domain: Invoice
the hydra core vocabulary: status
range: string

Invoice/totalAmountCents
type: Property
domain: Invoice
the hydra core vocabulary: totalAmountCents
range: integer

Invoice/periodStart
type: Property
domain: Invoice
the hydra core vocabulary: periodStart
range: dateTime

Invoice/periodEnd
type: Property
domain: Invoice
the hydra core vocabulary: periodEnd
range: dateTime

Invoice/createdAt
type: Property
domain: Invoice
the hydra core vocabulary: createdAt
range: dateTime

Invoice/paidAt
type: Property
domain: Invoice
the hydra core vocabulary: paidAt
range: dateTime

Invoice/paymentTransactionId
type: Property
domain: Invoice
the hydra core vocabulary: paymentTransactionId
range: string

Invoice/organization
type: Link
domain: Invoice
the hydra core vocabulary: organization
max cardinality: 1
range: Organization

Invoice/businessUnit
type: Link
domain: Invoice
the hydra core vocabulary: businessUnit
max cardinality: 1
range: BusinessUnit

Invoice/clinic
type: Link
domain: Invoice
the hydra core vocabulary: clinic
max cardinality: 1
range: Clinic

Invoice/provider
type: Link
domain: Invoice
the hydra core vocabulary: provider
max cardinality: 1
range: Provider

Invoice/patient
type: Link
domain: Invoice
the hydra core vocabulary: patient
max cardinality: 1
range: Patient

Invoice/lineItems
type: Property
domain: Invoice
the hydra core vocabulary: lineItems
range: InvoiceLineItem

InvoiceLineItem
type: Class
title: InvoiceLineItem
supported property: SupportedProperty
  property: InvoiceLineItem/sourceLog
  title: sourceLog
  required: false
  readable: true
  writeable: true
  description: The Source of Truth: Link to the audit event that triggered this charge.
supported property: SupportedProperty
  property: InvoiceLineItem/metadata
  title: metadata
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InvoiceLineItem/sourceType
  title: sourceType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InvoiceLineItem/sourceEntityId
  title: sourceEntityId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InvoiceLineItem/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: InvoiceLineItem/amountCents
  title: amountCents
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a InvoiceLineItem resource.
  method: GET
  returns: InvoiceLineItem
  title: getInvoiceLineItem

InvoiceLineItem/sourceLog
type: Link
domain: InvoiceLineItem
the hydra core vocabulary: sourceLog
max cardinality: 1
range: PrescriptionAuditLog

InvoiceLineItem/metadata
type: Property
domain: InvoiceLineItem
the hydra core vocabulary: metadata

InvoiceLineItem/sourceType
type: Property
domain: InvoiceLineItem
the hydra core vocabulary: sourceType

InvoiceLineItem/sourceEntityId
type: Property
domain: InvoiceLineItem
the hydra core vocabulary: sourceEntityId

InvoiceLineItem/description
type: Property
domain: InvoiceLineItem
the hydra core vocabulary: description
range: string

InvoiceLineItem/amountCents
type: Property
domain: InvoiceLineItem
the hydra core vocabulary: amountCents
range: integer

Clinic
type: Class
title: Clinic
supported property: SupportedProperty
  property: Clinic/name
  title: name
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Clinic resource.
  method: GET
  returns: Clinic
  title: getClinic
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Clinic resource.
  expects: Clinic
  method: PUT
  returns: Clinic
  title: putClinic
description: Clinic entity - Medical facility where providers work. Clinics belong to a BusinessUnit and contain Providers and serve Patients.

Clinic/name
type: Property
domain: Clinic
the hydra core vocabulary: name
range: string

Provider
type: Class
title: Provider
supported property: SupportedProperty
  property: Provider/firstName
  title: firstName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Provider/lastName
  title: lastName
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Provider resource.
  method: GET
  returns: Provider
  title: getProvider
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Provider resource.
  expects: Provider
  method: PUT
  returns: Provider
  title: putProvider
description: Provider entity - Prescribing healthcare professional. Providers (doctors, NPs, PAs) write prescriptions and are associated with clinics. Contains credentials for external systems like ScriptSure for e-prescribing.

Provider/firstName
type: Property
domain: Provider
the hydra core vocabulary: firstName
range: string

Provider/lastName
type: Property
domain: Provider
the hydra core vocabulary: lastName
range: string

EcommerceOrder
type: Class
title: EcommerceOrder
supported property: SupportedProperty
  property: EcommerceOrder/businessUnit
  title: businessUnit
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/clinic
  title: clinic
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/customerPhone
  title: customerPhone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/customerAddress
  title: customerAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/patient
  title: patient
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/lineItems
  title: lineItems
  required: false
  readable: true
  writeable: true
  description: Line items from e-commerce order (SKUs and quantities).
supported property: SupportedProperty
  property: EcommerceOrder/orderTotalCents
  title: orderTotalCents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/aiAnalysis
  title: aiAnalysis
  required: false
  readable: true
  writeable: true
  description: AI Analysis result (risk assessment, recommendations).
supported property: SupportedProperty
  property: EcommerceOrder/encounter
  title: encounter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/invoice
  title: invoice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EcommerceOrder/processedAt
  title: processedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EcommerceOrder/completedAt
  title: completedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: EcommerceOrder/externalOrderId
  title: externalOrderId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/source
  title: source
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/customerEmail
  title: customerEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/customerFirstName
  title: customerFirstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: EcommerceOrder/customerLastName
  title: customerLastName
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a EcommerceOrder resource.
  method: GET
  returns: EcommerceOrder
  title: getEcommerceOrder
description: EcommerceOrder entity - Tracks orders coming from e-commerce platforms. Orders flow: Received → Processing → Patient Matched → Drafts Created → Pending Review → Approved/Rejected → Completed

EcommerceOrder/businessUnit
type: Link
domain: EcommerceOrder
the hydra core vocabulary: businessUnit
max cardinality: 1
range: BusinessUnit

EcommerceOrder/clinic
type: Link
domain: EcommerceOrder
the hydra core vocabulary: clinic
max cardinality: 1
range: Clinic

EcommerceOrder/customerPhone
type: Property
domain: EcommerceOrder
the hydra core vocabulary: customerPhone
range: string

EcommerceOrder/customerAddress
type: Property
domain: EcommerceOrder
the hydra core vocabulary: customerAddress
range: string

EcommerceOrder/patient
type: Link
domain: EcommerceOrder
the hydra core vocabulary: patient
max cardinality: 1
range: Patient

EcommerceOrder/lineItems
type: Property
domain: EcommerceOrder
the hydra core vocabulary: lineItems

EcommerceOrder/orderTotalCents
type: Property
domain: EcommerceOrder
the hydra core vocabulary: orderTotalCents
range: integer

EcommerceOrder/status
type: Property
domain: EcommerceOrder
the hydra core vocabulary: status

EcommerceOrder/aiAnalysis
type: Property
domain: EcommerceOrder
the hydra core vocabulary: aiAnalysis

EcommerceOrder/encounter
type: Link
domain: EcommerceOrder
the hydra core vocabulary: encounter
max cardinality: 1
range: Encounter

EcommerceOrder/invoice
type: Link
domain: EcommerceOrder
the hydra core vocabulary: invoice
max cardinality: 1
range: Invoice

EcommerceOrder/createdAt
type: Property
domain: EcommerceOrder
the hydra core vocabulary: createdAt
range: dateTime

EcommerceOrder/processedAt
type: Property
domain: EcommerceOrder
the hydra core vocabulary: processedAt
range: dateTime

EcommerceOrder/completedAt
type: Property
domain: EcommerceOrder
the hydra core vocabulary: completedAt
range: dateTime

EcommerceOrder/externalOrderId
type: Property
domain: EcommerceOrder
the hydra core vocabulary: externalOrderId
range: string

EcommerceOrder/source
type: Property
domain: EcommerceOrder
the hydra core vocabulary: source

EcommerceOrder/customerEmail
type: Property
domain: EcommerceOrder
the hydra core vocabulary: customerEmail
range: string

EcommerceOrder/customerFirstName
type: Property
domain: EcommerceOrder
the hydra core vocabulary: customerFirstName
range: string

EcommerceOrder/customerLastName
type: Property
domain: EcommerceOrder
the hydra core vocabulary: customerLastName
range: string

SkuMapping
type: Class
title: SkuMapping
supported operation: Operation
  type: FindAction
  description: Retrieves a SkuMapping resource.
  method: GET
  returns: SkuMapping
  title: getSkuMapping
supported operation: Operation
  type: ReplaceAction
  description: Replaces the SkuMapping resource.
  expects: SkuMapping
  method: PUT
  returns: SkuMapping
  title: putSkuMapping
supported operation: Operation
  type: DeleteAction
  description: Deletes the SkuMapping resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteSkuMapping
description: SkuMapping entity - Maps e-commerce SKUs to medications per BusinessUnit. Each business unit can have their own SKU naming convention that maps to the canonical medication records in the system. Supports bundles via SkuMappingItem children (one SKU → multiple medications).

Encounter
type: Class
title: Encounter
supported property: SupportedProperty
  property: Encounter/provider
  title: provider
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Encounter/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Encounter/sourceType
  title: sourceType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Encounter/sourceId
  title: sourceId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Encounter/signedAt
  title: signedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Encounter/patient
  title: patient
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Encounter/type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Encounter/occurredAt
  title: occurredAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Encounter/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Encounter/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Encounter resource.
  method: GET
  returns: Encounter
  title: getEncounter
description: Encounter entity - Universal container for patient actions.

Encounter/provider
type: Link
domain: Encounter
the hydra core vocabulary: provider
max cardinality: 1
range: Provider

Encounter/status
type: Property
domain: Encounter
the hydra core vocabulary: status

Encounter/sourceType
type: Property
domain: Encounter
the hydra core vocabulary: sourceType
range: string

Encounter/sourceId
type: Property
domain: Encounter
the hydra core vocabulary: sourceId
range: string

Encounter/signedAt
type: Property
domain: Encounter
the hydra core vocabulary: signedAt
range: dateTime

Encounter/patient
type: Property
domain: Encounter
the hydra core vocabulary: patient
max cardinality: 1
range: Patient

Encounter/type
type: Property
domain: Encounter
the hydra core vocabulary: type

Encounter/occurredAt
type: Property
domain: Encounter
the hydra core vocabulary: occurredAt
range: dateTime

Encounter/createdAt
type: Property
domain: Encounter
the hydra core vocabulary: createdAt
range: dateTime

Encounter/updatedAt
type: Property
domain: Encounter
the hydra core vocabulary: updatedAt
range: dateTime

Medication
type: Class
title: Medication
supported property: SupportedProperty
  property: Medication/defaultQuantity
  title: defaultQuantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Medication/quantityUnits
  title: quantityUnits
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Medication/defaultSig
  title: defaultSig
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Medication/defaultDaysSupply
  title: defaultDaysSupply
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a Medication resource.
  method: GET
  returns: Medication
  title: getMedication
description: Medication entity - Drug catalog entry. Contains drug information from rx_mapping_3 table. Prices stored in cents to avoid floating point issues.

Medication/defaultQuantity
type: Property
domain: Medication
the hydra core vocabulary: defaultQuantity
range: integer

Medication/quantityUnits
type: Property
domain: Medication
the hydra core vocabulary: quantityUnits
range: string

Medication/defaultSig
type: Property
domain: Medication
the hydra core vocabulary: defaultSig
range: string

Medication/defaultDaysSupply
type: Property
domain: Medication
the hydra core vocabulary: defaultDaysSupply
range: integer

BusinessUnit
type: Class
title: BusinessUnit
supported operation: Operation
  type: FindAction
  description: Retrieves a BusinessUnit resource.
  method: GET
  returns: BusinessUnit
  title: getBusinessUnit
supported operation: Operation
  type: ReplaceAction
  description: Replaces the BusinessUnit resource.
  expects: BusinessUnit
  method: PUT
  returns: BusinessUnit
  title: putBusinessUnit
description: BusinessUnit entity - Sub-tenant with branding within an Organization. Business units own clinics and can have custom branding (logo, colors).

Organization
type: Class
title: Organization
supported operation: Operation
  type: FindAction
  description: Retrieves a Organization resource.
  method: GET
  returns: Organization
  title: getOrganization
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Organization resource.
  expects: Organization
  method: PUT
  returns: Organization
  title: putOrganization
description: Organization entity - Top-level tenant in the multi-tenant hierarchy. Organizations own business units, which own clinics, which have providers and patients.

Patient
type: Class
title: Patient
supported property: SupportedProperty
  property: Patient/clinic
  title: clinic
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Patient/firstName
  title: firstName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/lastName
  title: lastName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/middleName
  title: middleName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/gender
  title: gender
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/phone
  title: phone
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/addressLine1
  title: addressLine1
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/addressLine2
  title: addressLine2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/city
  title: city
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/zip
  title: zip
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/allergies
  title: allergies
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/medicalConditions
  title: medicalConditions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/isActive
  title: isActive
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: Patient/externalIdentifiers
  title: externalIdentifiers
  required: false
  readable: true
  writeable: false
  description: External identifiers linking this patient to external pharmacy systems.
supported property: SupportedProperty
  property: Patient/biometrics
  title: biometrics
  required: false
  readable: true
  writeable: false
  description: Patient biometrics (height, weight, BMI).
supported property: SupportedProperty
  property: Patient/treatmentIndications
  title: treatmentIndications
  required: false
  readable: true
  writeable: false
  description: Treatment indications (problem list).
supported property: SupportedProperty
  property: Patient/dob
  title: dob
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Patient/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Patient/updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Operation
  type: FindAction
  description: Retrieves a Patient resource.
  method: GET
  returns: Patient
  title: getPatient
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Patient resource.
  expects: Patient
  method: PUT
  returns: Patient
  title: putPatient
description: Patient entity - Person receiving prescriptions. HIPAA-sensitive: Contains PHI (Protected Health Information).

Patient/clinic
type: Property
domain: Patient
the hydra core vocabulary: clinic
max cardinality: 1
range: Clinic

Patient/firstName
type: Property
domain: Patient
the hydra core vocabulary: firstName
range: string

Patient/lastName
type: Property
domain: Patient
the hydra core vocabulary: lastName
range: string

Patient/middleName
type: Property
domain: Patient
the hydra core vocabulary: middleName
range: string

Patient/gender
type: Property
domain: Patient
the hydra core vocabulary: gender
range: string

Patient/email
type: Property
domain: Patient
the hydra core vocabulary: email
range: string

Patient/phone
type: Property
domain: Patient
the hydra core vocabulary: phone
range: string

Patient/addressLine1
type: Property
domain: Patient
the hydra core vocabulary: addressLine1
range: string

Patient/addressLine2
type: Property
domain: Patient
the hydra core vocabulary: addressLine2
range: string

Patient/city
type: Property
domain: Patient
the hydra core vocabulary: city
range: string

Patient/state
type: Property
domain: Patient
the hydra core vocabulary: state
range: string

Patient/zip
type: Property
domain: Patient
the hydra core vocabulary: zip
range: string

Patient/allergies
type: Property
domain: Patient
the hydra core vocabulary: allergies
range: string

Patient/medicalConditions
type: Property
domain: Patient
the hydra core vocabulary: medicalConditions
range: string

Patient/isActive
type: Property
domain: Patient
the hydra core vocabulary: isActive
range: boolean

Patient/externalIdentifiers
type: Property
domain: Patient
the hydra core vocabulary: externalIdentifiers

Patient/biometrics
type: Property
domain: Patient
the hydra core vocabulary: biometrics
max cardinality: 1
range: PatientBiometrics

Patient/treatmentIndications
type: Property
domain: Patient
the hydra core vocabulary: treatmentIndications
range: TreatmentIndication

Patient/dob
type: Property
domain: Patient
the hydra core vocabulary: dob
range: dateTime

Patient/createdAt
type: Property
domain: Patient
the hydra core vocabulary: createdAt
range: dateTime

Patient/updatedAt
type: Property
domain: Patient
the hydra core vocabulary: updatedAt
range: dateTime

PatientBiometrics
type: Class
title: PatientBiometrics
supported property: SupportedProperty
  property: PatientBiometrics/heightInches
  title: heightInches
  required: false
  readable: true
  writeable: true
  description: Height in inches (static, rarely changes).
supported property: SupportedProperty
  property: PatientBiometrics/weightLbs
  title: weightLbs
  required: false
  readable: true
  writeable: true
  description: Cached weight in pounds (synced from latest observation).
supported property: SupportedProperty
  property: PatientBiometrics/weightRecordedAt
  title: weightRecordedAt
  required: false
  readable: true
  writeable: false
  description: When the weight was last recorded.
supported property: SupportedProperty
  property: PatientBiometrics/bmi
  title: bmi
  required: false
  readable: true
  writeable: false
  description: Auto-calculated BMI.
supported property: SupportedProperty
  property: PatientBiometrics/targetWeightLbs
  title: targetWeightLbs
  required: false
  readable: true
  writeable: true
  description: Target weight for weight loss programs.
supported operation: Operation
  type: FindAction
  description: Retrieves a PatientBiometrics resource.
  method: GET
  returns: PatientBiometrics
  title: getPatientBiometrics
supported operation: Operation
  type: ReplaceAction
  description: Replaces the PatientBiometrics resource.
  expects: PatientBiometrics
  method: PUT
  returns: PatientBiometrics
  title: putPatientBiometrics
description: PatientBiometrics entity - Static biometric data for a patient. Stores height (rarely changes) and caches latest weight from observations. One-to-one relationship with Patient. HIPAA-sensitive: Contains PHI (Protected Health Information).

PatientBiometrics/heightInches
type: Property
domain: PatientBiometrics
the hydra core vocabulary: heightInches
range: string

PatientBiometrics/weightLbs
type: Property
domain: PatientBiometrics
the hydra core vocabulary: weightLbs
range: string

PatientBiometrics/weightRecordedAt
type: Property
domain: PatientBiometrics
the hydra core vocabulary: weightRecordedAt
range: dateTime

PatientBiometrics/bmi
type: Property
domain: PatientBiometrics
the hydra core vocabulary: bmi
range: string

PatientBiometrics/targetWeightLbs
type: Property
domain: PatientBiometrics
the hydra core vocabulary: targetWeightLbs
range: string

PatientChartNote
type: Class
title: PatientChartNote
supported property: SupportedProperty
  property: PatientChartNote/provider
  title: provider
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PatientChartNote/noteType
  title: noteType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PatientChartNote/isPinned
  title: isPinned
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: PatientChartNote/encounter
  title: encounter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PatientChartNote/content
  title: content
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a PatientChartNote resource.
  method: GET
  returns: PatientChartNote
  title: getPatientChartNote
supported operation: Operation
  type: ReplaceAction
  description: Replaces the PatientChartNote resource.
  expects: PatientChartNote
  method: PUT
  returns: PatientChartNote
  title: putPatientChartNote
supported operation: Operation
  type: DeleteAction
  description: Deletes the PatientChartNote resource.
  method: DELETE
  returns: owl:Nothing
  title: deletePatientChartNote
description: PatientChartNote entity - Free-text clinical notes. Simple notes that can be pinned, linked to encounters, and filtered by type. HIPAA-sensitive: Contains PHI (Protected Health Information).

PatientChartNote/provider
type: Link
domain: PatientChartNote
the hydra core vocabulary: provider
max cardinality: 1
range: Provider

PatientChartNote/noteType
type: Property
domain: PatientChartNote
the hydra core vocabulary: noteType
range: string

PatientChartNote/isPinned
type: Property
domain: PatientChartNote
the hydra core vocabulary: isPinned
range: boolean

PatientChartNote/encounter
type: Link
domain: PatientChartNote
the hydra core vocabulary: encounter
max cardinality: 1
range: Encounter

PatientChartNote/content
type: Property
domain: PatientChartNote
the hydra core vocabulary: content
range: string

TreatmentIndication
type: Class
title: TreatmentIndication
supported property: SupportedProperty
  property: TreatmentIndication/indicationName
  title: indicationName
  required: false
  readable: true
  writeable: true
  description: Custom name if using CUSTOM code, or override display name.
supported property: SupportedProperty
  property: TreatmentIndication/category
  title: category
  required: false
  readable: true
  writeable: true
  description: Category: 'indication' (medical reason) or 'goal' (health objective).
supported property: SupportedProperty
  property: TreatmentIndication/notes
  title: notes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TreatmentIndication/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TreatmentIndication/resolvedAt
  title: resolvedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TreatmentIndication/indicationCode
  title: indicationCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: TreatmentIndication/identifiedAt
  title: identifiedAt
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a TreatmentIndication resource.
  method: GET
  returns: TreatmentIndication
  title: getTreatmentIndication
supported operation: Operation
  type: ReplaceAction
  description: Replaces the TreatmentIndication resource.
  expects: TreatmentIndication
  method: PUT
  returns: TreatmentIndication
  title: putTreatmentIndication
supported operation: Operation
  type: DeleteAction
  description: Deletes the TreatmentIndication resource.
  method: DELETE
  returns: owl:Nothing
  title: deleteTreatmentIndication
description: TreatmentIndication entity - Custom problem list for functional medicine. NOT ICD codes - these are wellness-oriented treatment categories. HIPAA-sensitive: Contains PHI (Protected Health Information).

TreatmentIndication/indicationName
type: Property
domain: TreatmentIndication
the hydra core vocabulary: indicationName
range: string

TreatmentIndication/category
type: Property
domain: TreatmentIndication
the hydra core vocabulary: category
range: string

TreatmentIndication/notes
type: Property
domain: TreatmentIndication
the hydra core vocabulary: notes
range: string

TreatmentIndication/status
type: Property
domain: TreatmentIndication
the hydra core vocabulary: status

TreatmentIndication/resolvedAt
type: Property
domain: TreatmentIndication
the hydra core vocabulary: resolvedAt
range: dateTime

TreatmentIndication/indicationCode
type: Property
domain: TreatmentIndication
the hydra core vocabulary: indicationCode

TreatmentIndication/identifiedAt
type: Property
domain: TreatmentIndication
the hydra core vocabulary: identifiedAt
range: dateTime

Pharmacy
type: Class
title: Pharmacy
supported operation: Operation
  type: FindAction
  description: Retrieves a Pharmacy resource.
  method: GET
  returns: Pharmacy
  title: getPharmacy
supported operation: Operation
  type: ReplaceAction
  description: Replaces the Pharmacy resource.
  expects: Pharmacy
  method: PUT
  returns: Pharmacy
  title: putPharmacy
description: Pharmacy entity - Dispensing pharmacy. Contains pharmacy information and API configuration for prescription transmission. Relationships: - OneToMany with PharmacyChannel (transmission channels with credentials) - OneToMany with Medication (pharmacy's drug catalog)

Prescription
type: Class
title: Prescription
supported property: SupportedProperty
  property: Prescription/publicId
  title: publicId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/medication
  title: medication
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/pharmacy
  title: pharmacy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/encounter
  title: encounter
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/treatmentIndication
  title: treatmentIndication
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/sourceOrderId
  title: sourceOrderId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/source
  title: source
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/aiContext
  title: aiContext
  required: false
  readable: true
  writeable: false
  description: AI context - stores AI recommendation metadata when source=AI.
supported property: SupportedProperty
  property: Prescription/ecommerceOrder
  title: ecommerceOrder
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/originalSku
  title: originalSku
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/daysSupply
  title: daysSupply
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/refills
  title: refills
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/directions
  title: directions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/clinicalNotes
  title: clinicalNotes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/compoundingReason
  title: compoundingReason
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/dispenseQuantity
  title: dispenseQuantity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/quantityUnits
  title: quantityUnits
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/transmissionMethod
  title: transmissionMethod
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/shipTo
  title: shipTo
  required: false
  readable: true
  writeable: true
  description: Where to ship the prescription (Patient address or Clinic for pickup).
supported property: SupportedProperty
  property: Prescription/transmissionId
  title: transmissionId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/scriptsurePrescriptionId
  title: scriptsurePrescriptionId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/localTransactionId
  title: localTransactionId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/costCents
  title: costCents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/priceCents
  title: priceCents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: Prescription/trackingNumber
  title: trackingNumber
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/carrier
  title: carrier
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/trackingUrl
  title: trackingUrl
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/prescribedAt
  title: prescribedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Prescription/signedById
  title: signedById
  required: false
  readable: true
  writeable: false
  description: UUID of the user who signed this prescription.
supported property: SupportedProperty
  property: Prescription/signedByName
  title: signedByName
  required: false
  readable: true
  writeable: false
  description: Display name of the signer for audit trail.
supported property: SupportedProperty
  property: Prescription/signedByProxyUserId
  title: signedByProxyUserId
  required: false
  readable: true
  writeable: false
  description: UUID of the scribe who performed the signing action on behalf of the provider.
supported operation: Operation
description: Prescription entity - Core business object for medication orders. Represents a prescription written by a provider for a patient, to be filled by a pharmacy.

Prescription/publicId
type: Property
domain: Prescription
the hydra core vocabulary: publicId

Prescription/medication
type: Link
domain: Prescription
the hydra core vocabulary: medication
max cardinality: 1
range: Medication

Prescription/pharmacy
type: Link
domain: Prescription
the hydra core vocabulary: pharmacy
max cardinality: 1
range: Pharmacy

Prescription/encounter
type: Link
domain: Prescription
the hydra core vocabulary: encounter
max cardinality: 1
range: Encounter

Prescription/treatmentIndication
type: Link
domain: Prescription
the hydra core vocabulary: treatmentIndication
max cardinality: 1
range: TreatmentIndication

Prescription/sourceOrderId
type: Property
domain: Prescription
the hydra core vocabulary: sourceOrderId
range: string

Prescription/source
type: Property
domain: Prescription
the hydra core vocabulary: source

Prescription/aiContext
type: Property
domain: Prescription
the hydra core vocabulary: aiContext

Prescription/ecommerceOrder
type: Link
domain: Prescription
the hydra core vocabulary: ecommerceOrder
max cardinality: 1
range: EcommerceOrder

Prescription/originalSku
type: Property
domain: Prescription
the hydra core vocabulary: originalSku
range: string

Prescription/quantity
type: Property
domain: Prescription
the hydra core vocabulary: quantity
range: integer

Prescription/daysSupply
type: Property
domain: Prescription
the hydra core vocabulary: daysSupply
range: integer

Prescription/refills
type: Property
domain: Prescription
the hydra core vocabulary: refills
range: integer

Prescription/directions
type: Property
domain: Prescription
the hydra core vocabulary: directions
range: string

Prescription/clinicalNotes
type: Property
domain: Prescription
the hydra core vocabulary: clinicalNotes
range: string

Prescription/compoundingReason
type: Property
domain: Prescription
the hydra core vocabulary: compoundingReason

Prescription/dispenseQuantity
type: Property
domain: Prescription
the hydra core vocabulary: dispenseQuantity
range: integer

Prescription/quantityUnits
type: Property
domain: Prescription
the hydra core vocabulary: quantityUnits
range: string

Prescription/status
type: Property
domain: Prescription
the hydra core vocabulary: status

Prescription/transmissionMethod
type: Property
domain: Prescription
the hydra core vocabulary: transmissionMethod

Prescription/shipTo
type: Property
domain: Prescription
the hydra core vocabulary: shipTo

Prescription/transmissionId
type: Property
domain: Prescription
the hydra core vocabulary: transmissionId
range: string

Prescription/scriptsurePrescriptionId
type: Property
domain: Prescription
the hydra core vocabulary: scriptsurePrescriptionId
range: integer

Prescription/localTransactionId
type: Property
domain: Prescription
the hydra core vocabulary: localTransactionId
range: string

Prescription/costCents
type: Property
domain: Prescription
the hydra core vocabulary: costCents
range: integer

Prescription/priceCents
type: Property
domain: Prescription
the hydra core vocabulary: priceCents
range: integer

Prescription/trackingNumber
type: Property
domain: Prescription
the hydra core vocabulary: trackingNumber
range: string

Prescription/carrier
type: Property
domain: Prescription
the hydra core vocabulary: carrier
range: string

Prescription/trackingUrl
type: Property
domain: Prescription
the hydra core vocabulary: trackingUrl
range: string

Prescription/prescribedAt
type: Property
domain: Prescription
the hydra core vocabulary: prescribedAt
range: dateTime

Prescription/signedById
type: Property
domain: Prescription
the hydra core vocabulary: signedById

Prescription/signedByName
type: Property
domain: Prescription
the hydra core vocabulary: signedByName
range: string

Prescription/signedByProxyUserId
type: Property
domain: Prescription
the hydra core vocabulary: signedByProxyUserId

Prescription/signedByProxyUserName
type: Property
domain: Prescription
the hydra core vocabulary: signedByProxyUserName
range: string

Prescription/enteredByUserId
type: Property
domain: Prescription
the hydra core vocabulary: enteredByUserId

Prescription/enteredByUserName
type: Property
domain: Prescription
the hydra core vocabulary: enteredByUserName
range: string

Prescription/clinicalContextType
type: Property
domain: Prescription
the hydra core vocabulary: clinicalContextType
range: string

Prescription/clinicalContextSetAt
type: Property
domain: Prescription
the hydra core vocabulary: clinicalContextSetAt
range: dateTime

Prescription/transmittedAt
type: Property
domain: Prescription
the hydra core vocabulary: transmittedAt
range: dateTime

Prescription/filledAt
type: Property
domain: Prescription
the hydra core vocabulary: filledAt
range: dateTime

Prescription/shippedAt
type: Property
domain: Prescription
the hydra core vocabulary: shippedAt
range: dateTime

Prescription/estimatedDelivery
type: Property
domain: Prescription
the hydra core vocabulary: estimatedDelivery
range: dateTime

Prescription/deliveredAt
type: Property
domain: Prescription
the hydra core vocabulary: deliveredAt
range: dateTime

Prescription/createdAt
type: Property
domain: Prescription
the hydra core vocabulary: createdAt
range: dateTime

Prescription/updatedAt
type: Property
domain: Prescription
the hydra core vocabulary: updatedAt
range: dateTime

Prescription/transmissionAttempts
type: Property
domain: Prescription
the hydra core vocabulary: transmissionAttempts

Prescription/patient
type: Property
domain: Prescription
the hydra core vocabulary: patient
max cardinality: 1
range: Patient

Prescription/provider
type: Link
domain: Prescription
the hydra core vocabulary: provider
max cardinality: 1
range: Provider

PrescriptionAuditLog
type: Class
title: PrescriptionAuditLog
supported property: SupportedProperty
  property: PrescriptionAuditLog/action
  title: action
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/actorType
  title: actorType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/actorId
  title: actorId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/actorName
  title: actorName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/ipAddress
  title: ipAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/userAgent
  title: userAgent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/changedAt
  title: changedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrescriptionAuditLog/previousStatus
  title: previousStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/newStatus
  title: newStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/changedBy
  title: changedBy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionAuditLog/metadata
  title: metadata
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a PrescriptionAuditLog resource.
  method: GET
  returns: PrescriptionAuditLog
  title: getPrescriptionAuditLog

PrescriptionAuditLog/action
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: action
range: string

PrescriptionAuditLog/actorType
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: actorType
range: string

PrescriptionAuditLog/actorId
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: actorId
range: string

PrescriptionAuditLog/actorName
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: actorName
range: string

PrescriptionAuditLog/ipAddress
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: ipAddress
range: string

PrescriptionAuditLog/userAgent
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: userAgent
range: string

PrescriptionAuditLog/changedAt
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: changedAt
range: dateTime

PrescriptionAuditLog/previousStatus
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: previousStatus

PrescriptionAuditLog/newStatus
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: newStatus

PrescriptionAuditLog/changedBy
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: changedBy
range: string

PrescriptionAuditLog/metadata
type: Property
domain: PrescriptionAuditLog
the hydra core vocabulary: metadata

PrescriptionDraft
type: Class
title: PrescriptionDraft
supported property: SupportedProperty
  property: PrescriptionDraft/ecommerceOrder
  title: ecommerceOrder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/originalSku
  title: originalSku
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/daysSupply
  title: daysSupply
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/refills
  title: refills
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/directions
  title: directions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/pharmacyNotes
  title: pharmacyNotes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/aiRecommendations
  title: aiRecommendations
  required: false
  readable: true
  writeable: true
  description: AI Recommendations.
supported property: SupportedProperty
  property: PrescriptionDraft/providerNotes
  title: providerNotes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/rejectionReason
  title: rejectionReason
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrescriptionDraft/prescription
  title: prescription
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/treatmentIndication
  title: treatmentIndication
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrescriptionDraft/reviewedAt
  title: reviewedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrescriptionDraft/convertedAt
  title: convertedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: PrescriptionDraft/patient
  title: patient
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/provider
  title: provider
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/medication
  title: medication
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: PrescriptionDraft/quantity
  title: quantity
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a PrescriptionDraft resource.
  method: GET
  returns: PrescriptionDraft
  title: getPrescriptionDraft
supported operation: Operation
  description: Updates the PrescriptionDraft resource.
  expects: PrescriptionDraft
  expects header:
    header name: Content-Type
    possible value: application/merge-patch+json
  method: PATCH
  returns: PrescriptionDraft
  title: patchPrescriptionDraft
description: PrescriptionDraft entity - Draft prescriptions created from e-commerce orders. These are auto-generated from SKU mappings and require provider review before becoming actual prescriptions. HIPAA-sensitive: Contains PHI (Protected Health Information).

PrescriptionDraft/ecommerceOrder
type: Link
domain: PrescriptionDraft
the hydra core vocabulary: ecommerceOrder
max cardinality: 1
range: EcommerceOrder

PrescriptionDraft/originalSku
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: originalSku
range: string

PrescriptionDraft/daysSupply
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: daysSupply
range: integer

PrescriptionDraft/refills
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: refills
range: integer

PrescriptionDraft/directions
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: directions
range: string

PrescriptionDraft/pharmacyNotes
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: pharmacyNotes
range: string

PrescriptionDraft/status
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: status

PrescriptionDraft/aiRecommendations
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: aiRecommendations

PrescriptionDraft/providerNotes
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: providerNotes
range: string

PrescriptionDraft/rejectionReason
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: rejectionReason
range: string

PrescriptionDraft/prescription
type: Link
domain: PrescriptionDraft
the hydra core vocabulary: prescription
max cardinality: 1
range: Prescription

PrescriptionDraft/treatmentIndication
type: Link
domain: PrescriptionDraft
the hydra core vocabulary: treatmentIndication
max cardinality: 1
range: TreatmentIndication

PrescriptionDraft/createdAt
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: createdAt
range: dateTime

PrescriptionDraft/reviewedAt
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: reviewedAt
range: dateTime

PrescriptionDraft/convertedAt
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: convertedAt
range: dateTime

PrescriptionDraft/patient
type: Link
domain: PrescriptionDraft
the hydra core vocabulary: patient
max cardinality: 1
range: Patient

PrescriptionDraft/provider
type: Link
domain: PrescriptionDraft
the hydra core vocabulary: provider
max cardinality: 1
range: Provider

PrescriptionDraft/medication
type: Link
domain: PrescriptionDraft
the hydra core vocabulary: medication
max cardinality: 1
range: Medication

PrescriptionDraft/quantity
type: Property
domain: PrescriptionDraft
the hydra core vocabulary: quantity
range: integer

ProductSku
type: Class
title: ProductSku
supported property: SupportedProperty
  property: ProductSku/pharmacy
  title: pharmacy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ProductSku/description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ProductSku/isActive
  title: isActive
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: ProductSku/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ProductSku/sku
  title: sku
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ProductSku/medication
  title: medication
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: ProductSku/source
  title: source
  required: true
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a ProductSku resource.
  method: GET
  returns: ProductSku
  title: getProductSku
supported operation: Operation
  type: ReplaceAction
  description: Replaces the ProductSku resource.
  expects: ProductSku
  method: PUT
  returns: ProductSku
  title: putProductSku
description: ProductSku entity - Maps e-commerce SKUs to internal Medications. Each SKU is unique within its source platform.

ProductSku/pharmacy
type: Link
domain: ProductSku
the hydra core vocabulary: pharmacy
max cardinality: 1
range: Pharmacy

ProductSku/description
type: Property
domain: ProductSku
the hydra core vocabulary: description
range: string

ProductSku/isActive
type: Property
domain: ProductSku
the hydra core vocabulary: isActive
range: boolean

ProductSku/createdAt
type: Property
domain: ProductSku
the hydra core vocabulary: createdAt
range: dateTime

ProductSku/sku
type: Property
domain: ProductSku
the hydra core vocabulary: sku
range: string

ProductSku/medication
type: Link
domain: ProductSku
the hydra core vocabulary: medication
max cardinality: 1
range: Medication

ProductSku/source
type: Property
domain: ProductSku
the hydra core vocabulary: source
range: string

QueueItem
type: Class
title: QueueItem
supported property: SupportedProperty
  property: QueueItem/prescription
  title: prescription
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: QueueItem/status
  title: status
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: QueueItem/priority
  title: priority
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: QueueItem/ecommerceOrderId
  title: ecommerceOrderId
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: QueueItem/orderItems
  title: orderItems
  required: false
  readable: true
  writeable: false
  description: Raw order items from e-commerce (e.g., SKUs).
supported property: SupportedProperty
  property: QueueItem/aiAnalysis
  title: aiAnalysis
  required: false
  readable: true
  writeable: false
  description: AI Analysis result from RxGenie or other AI services.
supported property: SupportedProperty
  property: QueueItem/source
  title: source
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: QueueItem/providerNotes
  title: providerNotes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: QueueItem/rejectionReason
  title: rejectionReason
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: QueueItem/assignedAt
  title: assignedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: QueueItem/reviewedAt
  title: reviewedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: QueueItem/createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: QueueItem/provider
  title: provider
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: QueueItem/patient
  title: patient
  required: false
  readable: true
  writeable: true
supported operation: Operation
  type: FindAction
  description: Retrieves a QueueItem resource.
  method: GET
  returns: QueueItem
  title: getQueueItem
description: QueueItem entity - Represents an item in the provider review queue. Queue items are created when prescriptions need provider review. AI analysis (RxGenie) results are stored in the aiAnalysis JSON field. HIPAA-sensitive: Contains PHI (Protected Health Information).

QueueItem/prescription
type: Link
domain: QueueItem
the hydra core vocabulary: prescription
max cardinality: 1
range: Prescription

QueueItem/status
type: Property
domain: QueueItem
the hydra core vocabulary: status

QueueItem/priority
type: Property
domain: QueueItem
the hydra core vocabulary: priority

QueueItem/ecommerceOrderId
type: Property
domain: QueueItem
the hydra core vocabulary: ecommerceOrderId
range: string

QueueItem/orderItems
type: Property
domain: QueueItem
the hydra core vocabulary: orderItems

QueueItem/aiAnalysis
type: Property
domain: QueueItem
the hydra core vocabulary: aiAnalysis

QueueItem/source
type: Property
domain: QueueItem
the hydra core vocabulary: source
range: string

QueueItem/providerNotes
type: Property
domain: QueueItem
the hydra core vocabulary: providerNotes
range: string

QueueItem/rejectionReason
type: Property
domain: QueueItem
the hydra core vocabulary: rejectionReason
range: string

QueueItem/assignedAt
type: Property
domain: QueueItem
the hydra core vocabulary: assignedAt
range: dateTime

QueueItem/reviewedAt
type: Property
domain: QueueItem
the hydra core vocabulary: reviewedAt
range: dateTime

QueueItem/createdAt
type: Property
domain: QueueItem
the hydra core vocabulary: createdAt
range: dateTime

QueueItem/provider
type: Property
domain: QueueItem
the hydra core vocabulary: provider
max cardinality: 1
range: Provider

QueueItem/patient
type: Property
domain: QueueItem
the hydra core vocabulary: patient
max cardinality: 1
range: Patient

Entrypoint
type: Class
title: Entrypoint
supported property: SupportedProperty
  property: Entrypoint/appointment
  title: getAppointmentCollection
  description: The collection of Appointment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/billingPeriod
  title: getBillingPeriodCollection
  description: The collection of BillingPeriod resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/invoice
  title: getInvoiceCollection
  description: The collection of Invoice resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/clinic
  title: getClinicCollection
  description: The collection of Clinic resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/provider
  title: getProviderCollection
  description: The collection of Provider resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/ecommerceOrder
  title: getEcommerceOrderCollection
  description: The collection of EcommerceOrder resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/skuMapping
  title: getSkuMappingCollection
  description: The collection of SkuMapping resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/encounter
  title: getEncounterCollection
  description: The collection of Encounter resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/medication
  title: getMedicationCollection
  description: The collection of Medication resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/businessUnit
  title: getBusinessUnitCollection
  description: The collection of BusinessUnit resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/organization
  title: getOrganizationCollection
  description: The collection of Organization resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/patient
  title: getPatientCollection
  description: The collection of Patient resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/patientChartNote
  title: getPatientChartNoteCollection
  description: The collection of PatientChartNote resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/treatmentIndication
  title: getTreatmentIndicationCollection
  description: The collection of TreatmentIndication resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/pharmacy
  title: getPharmacyCollection
  description: The collection of Pharmacy resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/prescription
  title: getPrescriptionCollection
  description: The collection of Prescription resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/prescriptionAuditLog
  title: getPrescriptionAuditLogCollection
  description: The collection of PrescriptionAuditLog resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/prescriptionDraft
  title: getPrescriptionDraftCollection
  description: The collection of PrescriptionDraft resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/productSku
  title: getProductSkuCollection
  description: The collection of ProductSku resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: Entrypoint/queueItem
  title: getQueueItemCollection
  description: The collection of QueueItem resources
  readable: true
  writeable: false
supported operation: Operation
  method: GET
  title: index
  description: The API Entrypoint.
  returns: Entrypoint

Entrypoint/appointment
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Appointment
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Appointment resources.
  method: GET
  returns: Collection
  title: getAppointmentCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Appointment resource.
  expects: Appointment
  method: POST
  returns: Appointment
  title: postAppointment

Entrypoint/billingPeriod
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BillingPeriod
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of BillingPeriod resources.
  method: GET
  returns: Collection
  title: getBillingPeriodCollection
supported operation: Operation
  type: CreateAction
  description: Creates a BillingPeriod resource.
  expects: BillingPeriod
  method: POST
  returns: BillingPeriod
  title: postBillingPeriod

Entrypoint/invoice
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Invoice
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Invoice resources.
  method: GET
  returns: Collection
  title: getInvoiceCollection

Entrypoint/clinic
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Clinic
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Clinic resources.
  method: GET
  returns: Collection
  title: getClinicCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Clinic resource.
  expects: Clinic
  method: POST
  returns: Clinic
  title: postClinic

Entrypoint/provider
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Provider
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Provider resources.
  method: GET
  returns: Collection
  title: getProviderCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Provider resource.
  expects: Provider
  method: POST
  returns: Provider
  title: postProvider

Entrypoint/ecommerceOrder
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: EcommerceOrder
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of EcommerceOrder resources.
  method: GET
  returns: Collection
  title: getEcommerceOrderCollection

Entrypoint/skuMapping
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SkuMapping
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of SkuMapping resources.
  method: GET
  returns: Collection
  title: getSkuMappingCollection
supported operation: Operation
  type: CreateAction
  description: Creates a SkuMapping resource.
  expects: SkuMapping
  method: POST
  returns: SkuMapping
  title: postSkuMapping

Entrypoint/encounter
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Encounter
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Encounter resources.
  method: GET
  returns: Collection
  title: getEncounterCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Encounter resource.
  expects: Encounter
  method: POST
  returns: Encounter
  title: postEncounter

Entrypoint/medication
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Medication
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Medication resources.
  method: GET
  returns: Collection
  title: getMedicationCollection

Entrypoint/businessUnit
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: BusinessUnit
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of BusinessUnit resources.
  method: GET
  returns: Collection
  title: getBusinessUnitCollection
supported operation: Operation
  type: CreateAction
  description: Creates a BusinessUnit resource.
  expects: BusinessUnit
  method: POST
  returns: BusinessUnit
  title: postBusinessUnit

Entrypoint/organization
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Organization
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Organization resources.
  method: GET
  returns: Collection
  title: getOrganizationCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Organization resource.
  expects: Organization
  method: POST
  returns: Organization
  title: postOrganization

Entrypoint/patient
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Patient
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Patient resources.
  method: GET
  returns: Collection
  title: getPatientCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Patient resource.
  expects: Patient
  method: POST
  returns: Patient
  title: postPatient

Entrypoint/patientChartNote
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PatientChartNote
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of PatientChartNote resources.
  method: GET
  returns: Collection
  title: getPatientChartNoteCollection
supported operation: Operation
  type: CreateAction
  description: Creates a PatientChartNote resource.
  expects: PatientChartNote
  method: POST
  returns: PatientChartNote
  title: postPatientChartNote

Entrypoint/treatmentIndication
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: TreatmentIndication
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of TreatmentIndication resources.
  method: GET
  returns: Collection
  title: getTreatmentIndicationCollection
supported operation: Operation
  type: CreateAction
  description: Creates a TreatmentIndication resource.
  expects: TreatmentIndication
  method: POST
  returns: TreatmentIndication
  title: postTreatmentIndication

Entrypoint/pharmacy
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Pharmacy
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Pharmacy resources.
  method: GET
  returns: Collection
  title: getPharmacyCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Pharmacy resource.
  expects: Pharmacy
  method: POST
  returns: Pharmacy
  title: postPharmacy

Entrypoint/prescription
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Prescription
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of Prescription resources.
  method: GET
  returns: Collection
  title: getPrescriptionCollection
supported operation: Operation
  type: CreateAction
  description: Creates a Prescription resource.
  expects: Prescription
  method: POST
  returns: Prescription
  title: postPrescription

Entrypoint/prescriptionAuditLog
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PrescriptionAuditLog
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of PrescriptionAuditLog resources.
  method: GET
  returns: Collection
  title: getPrescriptionAuditLogCollection

Entrypoint/prescriptionDraft
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PrescriptionDraft
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of PrescriptionDraft resources.
  method: GET
  returns: Collection
  title: getPrescriptionDraftCollection

Entrypoint/productSku
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ProductSku
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of ProductSku resources.
  method: GET
  returns: Collection
  title: getProductSkuCollection
supported operation: Operation
  type: CreateAction
  description: Creates a ProductSku resource.
  expects: ProductSku
  method: POST
  returns: ProductSku
  title: postProductSku

Entrypoint/queueItem
type: Link
domain: Entrypoint
max cardinality: 1
range: Collection
range:
  equivalent class:
    on property: member
    all values from: QueueItem
supported operation: Operation
  type: FindAction
  description: Retrieves the collection of QueueItem resources.
  method: GET
  returns: Collection
  title: getQueueItemCollection

ConstraintViolationList
type: Class
title: ConstraintViolationList
description: A constraint violation List.
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolationList
range: string

message
type: Property
domain: ConstraintViolationList
range: string

SupportedProperty
property: Prescription/signedByProxyUserName
title: signedByProxyUserName
required: false
readable: true
writeable: false
description: Display name of the proxy signer (preserved if user deleted).

SupportedProperty
property: Prescription/enteredByUserId
title: enteredByUserId
required: false
readable: true
writeable: false
description: UUID of the user who entered this prescription (scribe attribution).

SupportedProperty
property: Prescription/enteredByUserName
title: enteredByUserName
required: false
readable: true
writeable: false
description: Display name of the user who entered this prescription.

SupportedProperty
property: Prescription/clinicalContextType
title: clinicalContextType
required: false
readable: true
writeable: false
description: Context type used when creating the prescription.

SupportedProperty
property: Prescription/clinicalContextSetAt
title: clinicalContextSetAt
required: false
readable: true
writeable: false
description: When the clinical context was set for this prescription.

SupportedProperty
property: Prescription/transmittedAt
title: transmittedAt
required: false
readable: true
writeable: false

SupportedProperty
property: Prescription/filledAt
title: filledAt
required: false
readable: true
writeable: false

SupportedProperty
property: Prescription/shippedAt
title: shippedAt
required: false
readable: true
writeable: false

SupportedProperty
property: Prescription/estimatedDelivery
title: estimatedDelivery
required: false
readable: true
writeable: false

SupportedProperty
property: Prescription/deliveredAt
title: deliveredAt
required: false
readable: true
writeable: false

SupportedProperty
property: Prescription/createdAt
title: createdAt
required: false
readable: true
writeable: false

SupportedProperty
property: Prescription/updatedAt
title: updatedAt
required: false
readable: true
writeable: false

SupportedProperty
property: Prescription/transmissionAttempts
title: transmissionAttempts
required: false
readable: true
writeable: false

SupportedProperty
property: Prescription/patient
title: patient
required: false
readable: true
writeable: true
description: Create a new prescription.

SupportedProperty
property: Prescription/provider
title: provider
required: false
readable: true
writeable: true
description: Create a new prescription.

Operation
type: FindAction
description: Retrieves a Prescription resource.
method: GET
returns: Prescription
title: getPrescription

Operation
type: ReplaceAction
description: Replaces the Prescription resource.
expects: Prescription
method: PUT
returns: Prescription
title: putPrescription

Operation
description: Updates the Prescription resource.
expects: Prescription
expects header:
  header name: Content-Type
  possible value: application/merge-patch+json
method: PATCH
returns: Prescription
title: patchPrescription