Aidbox User Docs
Run Aidbox locallyRun Aidbox in SandboxTalk to us Ask community
  • Aidbox FHIR platform documentation
    • Features
    • Architecture
  • Getting Started
    • Run Aidbox in Sandbox
    • Run Aidbox locally
    • Run Aidbox on AWS
    • Upload Sample Data
  • Tutorials
    • CRUD, Search Tutorials
      • Delete data
      • Set up uniqueness in Resource
      • Search Tutorials
        • Custom SearchParameter tutorial
        • Create custom Aidbox Search resource
        • Multilingual search tutorial
        • Migrate from Aidbox SearchParameter to FHIR SearchParameter
        • Change sort order by locale collation
    • Bulk API Tutorials
      • 🎓Synthea by Bulk API
      • 🎓$dump-sql tutorial
    • Security & Access Control Tutorials
      • Authentication Tutorial
      • Allow patients to see their own data
      • Restrict operations on resource type
      • Relationship-based access control
      • Creating user & set up full user access
      • Restricting Access to Patient Data
      • Create and test access control
      • RBAC
        • Flexible RBAC built-in to Aidbox
        • RBAC with JWT containing role
        • RBAC with ACL
      • Set-up token introspection
      • Prohibit user to login
      • Debug access control
      • Managing Admin Access to the Aidbox UI Using Okta Groups
      • Run Multibox locally
      • How to enable labels-based access control
      • How to enable patient data access API
      • How to enable SMART on FHIR on Patient Access API
      • How to enable hierarchical access control
      • How to configure Audit Log
    • Terminology Tutorials
      • Load ICD-10 terminology into Aidbox
      • Uploading IG terminology content to external FHIR terminology server
    • Validation Tutorials
      • Upload FHIR Implementation Guide
        • Environment Variable
        • Aidbox UI
          • IG Package from Aidbox Registry
          • Public URL to IG Package
          • Local IG Package
        • Aidbox FHIR API
        • UploadFIG Tool
      • ISiK
      • Carin BB
      • US Core
      • Davinci Pdex
      • mCode
    • Integration Toolkit Tutorials
      • Postmark integration tutorial
      • Mailgun integration tutorial
    • Subscriptions Tutorials
      • AidboxTopicSubscription NATS tutorial
    • Other tutorials
      • Run Aidbox with FHIR R6
      • Migrate from Multibox to Aidbox
      • SDC with Custom Resources
      • How to create FHIR NPM package
      • Migrate from legacy licence portal to Aidbox portal
      • How to run Aidbox in GCP Cloud Run
  • Overview
    • Licensing and Support
    • Aidbox user portal
      • Projects
      • Licenses
      • Members
    • Aidbox UI
      • Aidbox Notebooks
      • REST Console
      • Database Console
      • Attrs stats
      • DB Tables
      • DB Queries
    • Versioning
    • Release Notes
    • Contact us
  • Configuration
    • Settings
    • Configure Aidbox and Multibox
    • Init Bundle
  • API
    • REST API
      • CRUD
        • Create
        • Read
        • Update
        • Patch
        • Delete
      • FHIR Search
        • SearchParameter
        • Include and Revinclude
        • Chaining
      • Aidbox Search
      • Bundle
      • History
      • $everything on Patient
      • Other
        • Aidbox & FHIR formats
        • Capability Statement
        • $document
        • Observation/$lastn
        • $validate
        • SQL endpoints
        • $matcho
        • $to-format
        • Aidbox version
        • Health check
    • Bulk API
      • Configure Access Policies for Bulk API
      • $dump
      • $dump-sql
      • $dump-csv
      • $export
      • $load & /fhir/$load
      • $import & /fhir/$import
      • aidbox.bulk data import
      • Bulk import from an S3 bucket
    • Batch/Transaction
    • GraphQL API
    • Other APIs
      • Plan API
        • Provider Directory API
          • Practitioner
          • PractitionerRole
          • Organization
          • OrganizationAffiliation
        • Plan API Overview
      • Archive/Restore API
        • create-archive
        • restore-archive
        • prune-archived-data
        • delete-archive
      • ETAG support
      • Cache
      • Changes API
      • RPC API
      • Sequence API
      • Encryption API
      • Batch Upsert
  • Modules
    • Profiling and validation
      • FHIR Schema Validator
        • Aidbox FHIR IGs Registry
        • Setup Aidbox with FHIR Schema validation engine
      • Skip validation of references in resource using request header
      • Asynchronous resource validation
    • Security & Access Control
      • Authentication Flows
        • Basic Auth
        • Client Credentials Grant
        • Resource Owner Grant
        • Authorization Code Grant
        • Implicit Grant
        • Two Factor Authentication
        • External OAuth 2.0 Providers
        • Token Exchange
      • External identity providers
        • Aidbox
        • Okta
        • Azure AD
        • Azure AD with certificate authentication
        • Keycloak
        • GitHub
        • Microsoft AD FS
        • Apple
      • Access Control
        • AccessPolicy
        • Evaluation engines
        • Role-Based Access Control (/RBAC)
        • Attribute-based Access Control (/ABAC)
        • Multitenancy
        • Access control lists (/ACL)
        • Access policy dev tool
        • AccessPolicy best practices
      • Audit
        • Audit Log
    • Observability
      • Getting started
        • Run Aidbox with OpenTelemetry locally
        • How to export telemetry to the OTEL collector
      • Logs
        • How-to guides
          • OpenTelemetry logs
          • Elastic Logs and Monitoring Integration
          • Datadog Log management integration
          • Loki Log management integration
        • Tutorials
          • Log analysis and visualization tutorial
          • Export logs to Datadog tutorial
        • Extending Aidbox Logs
        • Technical reference
          • Log appenders
          • Log transformations
          • Log Schema
          • OTEL logs exporter parameters
      • Metrics
        • How-to guides
          • How to export metrics to the OTEL collector
          • Use Aidbox Metrics Server
          • Set-up Grafana integration
        • Technical reference
          • OpenTelemetry Metrics
          • OTEL metrics exporter parameters
      • Traces
        • How to use tracing
        • OTEL traces exporter parameters
    • Subscriptions
      • Aidbox topic-based subscriptions
        • Kafka AidboxTopicDestination
        • Webhook AidboxTopicDestination
        • GCP Pub/Sub AidboxTopicDestination
        • Tutorial: produce QuestionnaireResponse to Kafka topic
      • Aidbox SubSubscriptions
    • Aidbox Forms
      • Getting started
      • Aidbox Forms Interface
      • Aidbox UI Builder
        • UI Builder Interface
        • Form creation
          • Form Settings
          • Widgets
          • Components
          • Versioning
          • Form customisation in Theme Editor
          • Form signature
          • How-to guides
            • How to: populate forms with data
            • How to extract data from forms
            • How to calculate form filling percentage
          • Multilingual forms
          • FHIRPath Editor
        • Import Questionnaire
        • Form sharing
        • Printing forms
          • Template-based PDF generation
        • FHIR versions
        • Offline forms
        • Embedding
          • Request Interception
        • Configuration
        • Forms multitenancy
        • Building reports using SQL on FHIR
        • Integration with external terminology servers
        • External FHIR servers as a data backend
        • Store attachments in S3-like storages
      • Access Control in Forms
      • Audit Logging in Forms
      • Aidbox Form Gallery
    • Define extensions
      • Extensions using StructureDefinition
      • Extensions using FHIRSchema
    • Custom Resources
      • Custom resources using FHIR Schema
      • Custom resources using StructureDefinition
      • Migrate to FHIR Schema
        • Migrate custom resources defined with Entity & Attributes to FHIR Schema
        • Migrate custom resources defined with Zen to FHIR Schema
    • Aidbox terminology module
      • Concept
        • $translate-concepts
        • Handling hierarchies using ancestors
      • ValueSet
        • ValueSet Expansion
        • ValueSet Code Validation
        • Create a ValueSet
      • CodeSystem
        • CodeSystem Concept Lookup
        • CodeSystem Subsumption testing
        • CodeSystem Code Composition
      • Import external terminologies
        • Import flat file (/CSV)
        • $import operation
        • Ready-to-use terminologies
      • $translate on ConceptMap
    • SQL on FHIR
      • Defining flat views with View Definitions
      • Query data from flat views
      • Reference
    • Integration toolkit
      • C-CDA / FHIR Converter
        • List of supported templates
          • Admission Diagnosis Section (/V3)
          • Advance Directives Section (/entries optional) (/V3)
          • Advance Directives Section (/entries required) (/V3)
          • Allergies and Intolerances Section (/entries optional) (/V3)
          • Allergies and Intolerances Section (/entries required) (/V3)
          • Assessment Section
          • Chief Complaint Section
          • Chief Complaint and Reason for Visit Section
          • Complications Section (/V3)
          • Course of Care Section
          • DICOM Object Catalog Section - DCM 121181
          • Default Section Rules
          • Discharge Diagnosis Section (/V3)
          • Document Header
          • Encounters Section (/entries optional) (/V3)
          • Encounters Section (/entries required) (/V3)
          • Family History Section (/V3)
          • Functional Status Section (/V2)
          • General Status Section
          • Goals Section
          • Health Concerns Section (/V2)
          • History of Present Illness Section
          • Hospital Consultations Section
          • Hospital Course Section
          • Hospital Discharge Instructions Section
          • Hospital Discharge Physical Section
          • Hospital Discharge Studies Summary Section
          • Immunizations Section (/entries optional) (/V3)
          • Immunizations Section (/entries required) (/V3)
          • Medical (/General) History Section
          • Medical Equipment Section (/V2)
          • Medications Administered Section (/V2)
          • Medications Section (/entries optional) (/V2)
          • Medications Section (/entries required) (/V2)
          • Mental Status Section (/V2)
          • Notes
          • Nutrition Section
          • Objective Section
          • Operative Note Fluids Section
          • Operative Note Surgical Procedure Section
          • Past Medical History (/V3)
          • Payers Section (/V3)
          • Plan of Treatment Section (/V2)
          • Postprocedure Diagnosis Section (/V3)
          • Preoperative Diagnosis Section (/V3)
          • Problem Section (/entries optional) (/V3)
          • Problem Section (/entries required) (/V3)
          • Procedure Description Section
          • Procedure Disposition Section
          • Procedure Estimated Blood Loss Section
          • Procedure Implants Section
          • Procedure Specimens Taken Section
          • Procedures Section (/entries optional) (/V2)
          • Procedures Section (/entries required) (/V2)
          • Reason for Visit Section
          • Results Section (/entries optional) (/V3)
          • Results Section (/entries required) (/V3)
          • Review of Systems Section
          • Social History Section (/V3)
          • Vital Signs Section (/entries optional) (/V3)
          • Vital Signs Section (/entries required) (/V3)
        • How to deploy the service
        • Producing C-CDA documents
        • How to customize conversion rules
      • HL7 v2 Integration
        • HL7 v2 integration with Aidbox Project
        • Mappings with lisp/mapping
      • X12 message converter
      • Analytics
        • Power BI
      • Mappings
      • Email Providers integration
        • Setup SMTP provider
    • SMARTbox | FHIR API for EHRs
      • Get started
        • Set up Smartbox locally
        • Deploy Smartbox with Kubernetes
      • (/g)(/10) Standardized API for patient and population services
      • The B11 Decision Support Interventions
        • Source attributes
        • Feedback Sections
      • How-to guides
        • Pass Inferno tests with Smartbox
        • Perform EHR launch
        • Pass Inferno Visual Inspection and Attestation
        • Revoke granted access
        • Set up EHR-level customization
        • Check email templates
        • Setup email provider
        • Register users
        • Set up SSO with Auth0
        • Publish Terms of Use link onto the documentation page
        • Find out what resources were exported during the $export operation
        • Find documentation endpoint
      • Background information
        • Considerations for Testing with Inferno ONC
        • Adding Clients for Inferno tests
        • Multitenancy approach
        • What is Tenant
        • Email templating
    • ePrescription
      • Getting started
      • Authentication with mTLS
      • Pharmacies synchronization
      • Prescribing
        • NewRx Message
        • CancelRx Message
        • How to test Callback
      • Directory
        • DirectoryDownload Message
        • GetProviderLocation Message
        • AddProviderLocation Message
        • UpdateProviderLocation Message
        • DisableProviderLocation Message
      • Medications
        • FDB
      • References
        • Environment Variables
      • Frequently Asked Questions
    • Other modules
      • MDM
        • Train model
        • Configure MDM module
        • Find duplicates: $match
        • Mathematical details
      • MCP
  • Database
    • Database schema
    • PostgreSQL Extensions
    • AidboxDB
      • HA AidboxDB
    • Tutorials
      • Migrate to AidboxDB 16
      • Working with pgAgent
  • File storage
    • AWS S3
    • GCP Cloud Storage
    • Azure Blob Storage
    • Oracle Cloud Storage
  • Deployment and maintenance
    • Deploy Aidbox
      • Run Aidbox on Kubernetes
        • Deploy Production-ready Aidbox to Kubernetes
        • Deploy Aidbox with Helm Charts
        • Highly Available Aidbox
        • Self-signed SSL certificates
      • Run Aidbox on managed PostgreSQL
      • How to inject env variables into Init Bundle
    • Backup and Restore
      • Crunchy Operator (/pgBackRest)
      • pg_dump
      • pg_basebackup
      • WAL-G
    • Indexes
      • Get suggested indexes
      • Create indexes manually
  • App development
    • Use Aidbox with React
    • Aidbox SDK
      • Aidbox JavaScript SDK
      • Apps
      • NodeJs SDK
      • Python SDK
    • Examples
  • Reference
    • FHIR Schema reference
    • Settings reference
      • General
      • FHIR
      • Security & Access Control
      • Modules
      • Database
      • Web Server
      • Observability
      • Zen Project
    • Environment variables
      • Aidbox required environment variables
      • Optional environment variables
      • AidboxDB environment variables
    • System resources reference
      • IAM Module Resources
      • SDC Module Resources
      • Base Module Resources
      • Bulk Module Resources
      • AWF Module Resources
      • Cloud Module Resources
      • HL7v2 Module Resources
      • SQL on FHIR Module Resources
    • Email Providers reference
      • Notification resource reference
      • Mailgun environment variables
      • Postmark environment variables
    • Aidbox Forms reference
      • FHIR SDC API
      • Aidbox SDC API
      • Generating Questionnaire from PDF API
    • Aidbox SQL functions
  • Deprecated
    • Deprecated
      • Zen-related
        • RPC reference
          • aidbox
            • mdm
              • aidbox.mdm/update-mdm-tables
              • aidbox.mdm/match
        • FTR
        • Aidbox configuration project
          • Run Aidbox locally using Aidbox Configuraiton project
          • Aidbox configuration project structure
          • Set up and use configuration projects
          • Enable IGs
          • Repository
          • Seed Import
          • Manage Indexes in Zen Project
          • Seed v2
          • 🎓Migrate to git Aidbox Configuration Projects
          • Aidbox Configuration project reference
            • Zen Configuration
            • Aidbox project RPC reference
            • aidbox.config/config
          • Custom resources using Aidbox Project
          • First-Class Extensions using Zen
          • Zen Indexes
        • US Core IG
          • US Core IG support reference
        • Workflow Engine
          • Task
            • Aidbox Built-in Tasks
            • Task Executor API
            • Task User API
          • Workflow
            • Workflow User API
          • Services
          • Monitoring
        • FHIR conformance Deprecated guides
          • Touchstone FHIR 4.0.1 basic server
          • Touchstone FHIR USCore ClinData
          • How to enable US Core IG
            • Start Aidbox locally with US Core IG enabled
            • Add US Core IG to a running Aidbox instance
          • HL7 FHIR Da Vinci PDex Plan Net IG
        • Terminology Deprecated Tutorials
          • Inferno Test-Suite US Core 3.1.1
        • API constructor (/beta)
        • zen-lang validator
          • Write a custom zen profile
          • Load zen profiles into Aidbox
        • FHIR topic-based subscriptions
          • Set up SubscriptionTopic
          • Tutorial: Subscribe to Topic (/R4B)
          • API Reference
            • Subscription API
        • 🏗️FHIR Terminology Repository
          • FTR Specification
          • Create an FTR instance
            • FTR from CSV
            • FTR from FHIR IG
            • FTR from FTR — Direct Dependency
            • FTR from FTR — Supplement
          • FTR Manifest
          • Load SNOMED CT into Aidbox
          • Load LOINC into Aidbox
          • Load ICD-10-CM into Aidbox
          • Load RxNorm into Aidbox
          • Load US VSAC Package to Aidbox
          • Import via FTR
        • Zen Search Parameters
      • Entity / Attribute
        • Entities & Attributes
        • First-Class Extensions using Attribute
        • Custom Resources using Entity
        • Working with Extensions
        • Aidbox Search Parameters
      • Forms
      • Other
        • Custom Search
        • SearchQuery
        • Subscribe to new Patient resource
        • App Development Deprecated Tutorials
          • Receive logs from your app
            • X-Audit header
          • Working with Aidbox from .NET
          • Patient Encounter notification Application
        • Other Deprecated Tutorials
          • Resource generation with map-to-fhir-bundle-task and subscription triggers
          • APM Aidbox
          • Automatically archive AuditEvent resources in GCP storage guide
          • HL7 v2 pipeline with Patient mapping
          • How to migrate to Apline Linux
          • How to migrate transaction id to bigint
          • How to fix broken dates
          • Configure multi-tenancy
        • AidboxProfile
        • GCP Pub/Sub
Powered by GitBook
On this page
  • Overview
  • AidboxArchive
  • AidboxConfig
  • AidboxJob
  • AidboxJobStatus
  • AidboxMigration
  • AidboxProfile
  • AidboxQuery
  • AidboxSubscription
  • App
  • Attribute
  • BatchValidationError
  • BatchValidationRun
  • Concept
  • ConceptMapRule
  • Entity
  • FlatImportStatus
  • FtrConfig
  • IndexCreationJob
  • Lambda
  • Mapping
  • Module
  • Notebook
  • Operation
  • PGSequence
  • Search
  • SearchQuery
  • SeedImport
  • SubsNotification
  • SubsSubscription
  • TerminologyBundleFile
  • ui_history
  • ui_snippet

Was this helpful?

Edit on GitHub
  1. Reference
  2. System resources reference

Base Module Resources

System resources that do not belong to any specific module.

Overview

Base module includes the following resource types:

  • AidboxArchive

  • AidboxConfig

  • AidboxJob

  • AidboxJobStatus

  • AidboxMigration

  • AidboxProfile

  • AidboxQuery

  • AidboxSubscription

  • App

  • Attribute

  • BatchValidationError

  • BatchValidationRun

  • Concept

  • ConceptMapRule

  • Entity

  • FlatImportStatus

  • FtrConfig

  • IndexCreationJob

  • Lambda

  • Mapping

  • Module

  • Notebook

  • Operation

  • PGSequence

  • Search

  • SearchQuery

  • SeedImport

  • SubsNotification

  • SubsSubscription

  • TerminologyBundleFile

  • ui_history

  • ui_snippet

AidboxArchive

Path
Card.
Type
Description

archiveFile

0..1

string

Name of the archive file.

archivedResourcesCount

0..1

number

Count of resources that have been archived.

bucket

0..1

string

Storage bucket where archives are stored.

criteriaPaths

0..*

string

Paths to use for filtering resources to archive.

history

0..1

boolean

Whether to include resource history in the archive.

period

0..1

BackboneElement

Time period for the resources to archive.

period.start

0..1

dateTime

Start date/time for the archive period.

period.end

0..1

dateTime

End date/time for the archive period.

serviceAccount

0..1

BackboneElement

Service account credentials for accessing storage.

serviceAccount.id

0..1

string

Identifier for the service account.

serviceAccount.resourceType

0..1

string

Type of resource that contains service account credentials.

serviceAccount.display

0..1

string

Human-readable name for the service account.

serviceAccount.secret-key

0..1

string

Secret key for service account authentication.

storageBackend

0..1

string

Type of storage backend to use.

Allowed values: gcp | aws | local

targetResourceType

0..1

string

Resource type to be archived.

AidboxConfig

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

auth

0..1

BackboneElement

Authentication configuration settings.

auth.keys

0..1

BackboneElement

Cryptographic keys for authentication.

auth.keys.secret

0..1

string

Secret key used for signing.

auth.keys.public

0..1

string

Public key used for verification.

box

0..1

Box configuration parameters.

AidboxJob

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

action

0..1

Object

Action to be performed when the job runs.

at

0..1

string

Time of day when the job should run (for each-day type).

every

0..1

integer

Frequency in seconds at which the job should run.

module

0..1

string

Module that this job belongs to.

status

0..1

Object

Current status information for the job.

text

0..1

string

Human-readable description of the job.

type

0..1

string

Type of job scheduling pattern.

Allowed values: periodic | each-day

AidboxJobStatus

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

error

0..1

Object

Error information if the job failed.

job

0..1

Reference

Reference to the job definition.

locked

0..1

boolean

Indicates whether the job is currently locked to prevent concurrent execution.

module

0..1

string

Module that this job status belongs to.

nextStart

0..1

dateTime

Scheduled time for the next execution of the job.

result

0..1

Object

Result data from the job execution.

start

0..1

dateTime

Time when the job execution started.

status

0..1

string

Current status of the job execution.

stop

0..1

dateTime

Time when the job execution stopped.

text

0..1

string

Human-readable status information.

AidboxMigration

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

action

0..1

Object

Action to be performed for the migration.

dateTime

0..1

dateTime

Time when the migration was created or executed.

module

0..1

string

Module that this migration belongs to.

result

0..1

Object

Result data from the migration execution.

status

0..1

string

Current status of the migration.

Allowed values: pending | done | error

text

0..1

string

Human-readable description of the migration.

AidboxProfile

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

bind

1..1

Reference

Reference to the resource to which this profile is bound.

schema

1..1

Object

Schema definition for the profile.

AidboxQuery

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

count-query

0..1

string

SQL query to count total results.

enable-links

0..1

boolean

Whether to generate FHIR links for pagination.

omit-sql

0..1

boolean

Whether to omit SQL in response metadata.

params

0..1

Object

Parameters for the query.

query

1..1

string

SQL query string.

type

0..1

string

Type of query operation.

Allowed values: query | execute

AidboxSubscription

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

action

0..1

Object

Action to be performed when the subscription is triggered.

module

0..1

string

Module that this subscription belongs to.

resources

0..*

string

List of resource types this subscription applies to.

type

0..1

string

Type of subscription execution model.

Allowed values: sync | async

App

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

apiVersion

1..1

integer

Version of the API this app uses.

endpoint

0..1

BackboneElement

Endpoint configuration for the app.

endpoint.secret

0..1

string

Secret key for endpoint authentication.

endpoint.url

0..1

string

URL of the endpoint.

endpoint.type

0..1

code

Type of endpoint protocol.

Allowed values: http-rpc | ws-rpc | native

entities

0..1

Object

Entities defined by the app.

hooks

0..1

Object

Hooks configuration for the app.

migrations

0..*

BackboneElement

List of migrations for this app.

migrations.id

0..1

string

Unique identifier for the migration.

migrations.dateTime

0..1

string

Timestamp for the migration.

migrations.action

0..1

string

Action to be performed for the migration.

operations

0..1

Object

Operations defined by the app.

subscriptions

0..1

Object

Subscriptions configuration for the app.

type

1..1

code

Type of application.

Allowed values: app | addon

Attribute

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

description

0..1

string

Human-readable description of the attribute.

enum

0..*

string

Enumeration of allowed values for this attribute.

extensionUrl

0..1

string

URL for the extension this attribute represents.

isCollection

0..1

boolean

Whether this attribute is a collection.

isModifier

0..1

boolean

Whether this attribute changes the meaning of the resource.

isOpen

0..1

boolean

Whether this attribute allows additional properties.

isRequired

0..1

boolean

Whether this attribute is required.

isSummary

0..1

boolean

Whether this attribute is included in summary views.

isUnique

0..1

boolean

Whether this attribute has unique values.

module

0..1

string

Module that this attribute belongs to.

order

0..1

integer

Order for display or processing.

path

0..*

string

Path to the attribute within the resource.

refers

0..*

string

Resource types this attribute can reference.

resource

1..1

Reference

Reference to the resource type this attribute belongs to.

schema

0..1

Object

Schema for the attribute.

text

0..1

string

Human-readable text about the attribute.

type

0..1

Reference

Reference to the attribute's data type.

union

0..*

Reference

References to other attributes in a union type.

valueSet

0..1

Value set constraint for this attribute.

valueSet.resourceType

0..1

string

Type of the value set resource.

valueSet.id

0..1

string

Identifier of the value set.

valueSet.uri

0..1

string

URI of the value set.

BatchValidationError

Path
Card.
Type
Description

errors

0..*

Object

List of validation errors found.

profiles

0..*

string

Profiles against which the resource was validated.

resource

0..1

BackboneElement

Reference to the resource that failed validation.

resource.id

0..1

string

Resource identifier.

resource.resourceType

0..1

string

Type of resource.

resource.display

0..1

string

Human-readable display name for the resource.

run

0..1

BackboneElement

Reference to the validation run that produced this error.

run.id

0..1

string

Validation run identifier.

run.resourceType

0..1

string

Type of the validation run resource.

run.display

0..1

string

Human-readable display name for the validation run.

BatchValidationRun

Path
Card.
Type
Description

async

0..1

boolean

Whether validation is performed asynchronously.

duration

0..1

integer

Duration of the validation run in milliseconds.

errorsThreshold

0..1

integer

Maximum number of errors before stopping validation.

filter

0..1

string

Expression to filter resources for validation.

invalid

0..1

integer

Count of invalid resources found.

limit

0..1

integer

Maximum number of resources to validate.

profiles

0..*

string

FHIR profiles to validate against.

resource

0..1

string

Resource type to validate.

schemas

0..*

string

List of schemas to validate against.

status

0..1

string

Current status of the validation run.

Allowed values: in-progress | complete

valid

0..1

integer

Count of valid resources found.

Concept

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

ancestors

0..1

Object

List of ancestor concepts in the hierarchy.

code

1..1

string

Symbol or identifier for the concept within the system.

definition

0..1

string

Formal definition of the concept.

deprecated

0..1

boolean

Indicates whether the concept is deprecated.

designation

0..1

BackboneElement

Additional representations for the concept.

designation.definition

0..1

Object

Additional definitions for the concept.

designation.display

0..1

Object

Display names in different languages or contexts.

display

0..1

string

Human-readable representation of the concept.

hierarchy

0..*

string

Hierarchies this concept belongs to.

property

0..1

Object

Additional properties associated with the concept.

system

1..1

string

Code system that defines the concept.

valueset

0..*

string

Value sets that include this concept.

ConceptMapRule

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

conceptmapId

0..1

string

ID of the parent concept map.

conceptmapUrl

0..1

string

URL of the parent concept map.

element

0..1

Object

Element mapping definition.

element.target

0..1

Target mapping information.

element.target.comment

0..1

string

Comment about the mapping.

element.target.equivalence

0..1

string

Equivalence relationship between source and target.

source

0..1

string

Source system for the mapping.

sourceValueSet

0..1

string

Source value set for the mapping.

target

0..1

string

Target system for the mapping.

targetValueSet

0..1

string

Target value set for the mapping.

unmapped

0..1

Object

Rules for handling unmapped concepts.

unmapped.url

0..1

string

URL for unmapped value set.

unmapped.mode

0..1

string

Mode for handling unmapped concepts.

Entity

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

description

0..1

string

Human-readable description of the entity.

history

0..1

string

History tracking mode for this entity.

Allowed values: none | diff

idGeneration

0..1

string

Strategy for generating IDs for this entity.

Allowed values: sequence | uuid

isMeta

0..1

boolean

Whether this entity is a metadata entity.

isOpen

0..1

boolean

Whether this entity allows additional properties.

module

0..1

string

Module that this entity belongs to.

nonPersistable

0..1

boolean

Whether this entity should not be persisted.

schema

0..1

Object

Schema definition for the entity.

sequencePrefix

0..1

string

Prefix for sequence-generated IDs.

text

0..1

string

Human-readable text about the entity.

type

1..1

string

Type of entity definition.

Allowed values: abstract | resource | type | primitive

FlatImportStatus

Path
Card.
Type
Description

error

0..1

Error information when import fails.

error.code

0..1

string

Error code.

error.message

0..1

string

Error message description.

params

0..1

Object

Parameters used for the import.

result

0..1

Result information for successful import.

result.count

0..1

integer

Count of successfully imported resources.

status

0..1

string

Current status of the import process.

Allowed values: in-progress | done | fail

FtrConfig

Path
Card.
Type
Description

module

0..1

string

Module that this configuration belongs to.

package-name

0..1

string

Name of the FHIR terminology package.

tag

0..1

string

Tag for terminology resources.

tag-index

0..1

Index of tags and their associations.

IndexCreationJob

Path
Card.
Type
Description

end

0..1

dateTime

Time when the index creation finished.

index

0..1

string

Name of the database index being created.

message

0..1

string

Status or error message.

params

0..*

string

Parameters for the index creation.

procstatus

0..1

string

Current status of the index creation process.

Allowed values: pending | in-progress | done | error

resource

0..1

string

Resource type for which the index is being created.

start

0..1

dateTime

Time when the index creation started.

Lambda

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

code

1..1

string

Code to be executed by the lambda.

hook

1..1

code

Type of hook this lambda responds to.

Allowed values: audit

Mapping

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

body

1..1

Object

Mapping transformation definition.

params

0..1

Parameters for the mapping execution.

params.omit-drop-blanks

0..1

boolean

Whether to omit blank values from the result.

returns

0..1

code

Type of result returned by the mapping.

Allowed values: transaction | resource

scopeSchema

0..1

Object

Schema defining the scope for mapping.

text

0..1

Human-readable text about the mapping.

text.status

0..1

string

Status of the text.

text.div

0..1

string

HTML representation of the text.

Module

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

meta

0..1

Meta

Metadata for the module.

meta.pre-sql

0..1

string

SQL to execute before module installation.

meta.post-sql

0..1

string

SQL to execute after module installation.

module

0..1

string

Identifier for the module.

version

0..1

integer

Version number of the module.

Notebook

Path
Card.
Type
Description

cells

0..*

Cells contained in the notebook.

cells.id

0..1

Unique identifier for the cell.

cells.evaluating?

0..1

boolean

Whether the cell is currently being evaluated.

cells.folded

0..1

Folding state of the cell.

cells.folded.code

0..1

boolean

Whether the code section is folded.

cells.folded.result

0..1

boolean

Whether the result section is folded.

cells.type

0..1

string

Type of cell content.

Allowed values: rpc | rest | empty | markdown | sql

cells.value

0..1

Content value of the cell.

cells.result

0..1

Result of cell evaluation.

cells.error

0..1

Error information if evaluation failed.

cells.nb-title

0..1

string

Title for the cell.

description

0..1

string

Description of the notebook.

edit-secret

0..1

string

Secret for edit access to the notebook.

name

0..1

string

Name of the notebook.

notebook-superuser-secret

0..1

string

Secret for superuser access to the notebook.

origin

0..1

string

Origin information for the notebook.

publication-id

0..1

string

Identifier for the published version of the notebook.

source

0..1

Source content for the notebook.

tags

0..*

string

Tags associated with the notebook.

Operation

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

action

0..1

Object

Action to be performed by the operation.

app

0..1

Reference

Reference to associated App.

Allowed references: App

data

0..1

Object

Additional operation data.

description

0..1

string

Human-readable description of the operation.

fhirCode

0..1

string

FHIR operation code.

fhirResource

0..*

string

FHIR resources this operation applies to.

fhirUrl

0..1

string

FHIR URL pattern for the operation.

implicit-params

0..1

BackboneElement

Parameters that are implicitly included in the operation.

implicit-params.path

0..1

Object

Path parameters.

implicit-params.query

0..1

Object

Query parameters.

module

0..1

string

Module that this operation belongs to.

no-op-logs

0..1

boolean

Whether to disable operation logging.

public

0..1

boolean

Whether the operation is publicly accessible.

request

0..*

Object

Request configurations.

route-params

0..1

Object

Parameters for route matching.

transform

0..1

BackboneElement

Transformation configuration for the operation.

transform.request

0..1

BackboneElement

Request transformation settings.

transform.request.engine

0..1

code

Transformation engine to use.

transform.request.template

0..1

Reference

Reference to a template for transformation.

transform.request.part

1..1

string

Part of the request to transform.

Allowed values: body

PGSequence

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

cycle

0..1

boolean

Whether the sequence should cycle when reaching max/min value.

data_type

0..1

string

PostgreSQL data type for the sequence.

Allowed values: smallint | integer | bigint

increment

0..1

integer

Value to increment by for each sequence call.

maxvalue

0..1

integer

Maximum value for the sequence.

minvalue

0..1

integer

Minimum value for the sequence.

start

0..1

integer

Starting value for the sequence.

Search

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

format

0..1

string

Replaces `?` with the actual value provided in the search query. Useful to use in ILIKE SQL expression.

module

0..1

string

Module that this search belongs to.

multi

0..1

string

If you set multi = 'array', parameters will be coerced as PostgreSQL array.

Allowed values: array

name

0..1

string

Name of the search parameter.

order-by

0..1

string

SQL to use in the ORDER BY expression. Supports {{table}} and {{param}}. Note that it is used only when _sort= present in the query.

param-parser

0..1

string

Parse value as string, identifier, or reference. See below.

Allowed values: token | reference

resource

0..1

Reference

Reference to the resource type this search applies to. ResourceType is always Entity

token-sql

0..1

BackboneElement

SQL templates for token parameter handling.

token-sql.text

0..1

string

SQL template for text search.

token-sql.both

0..1

string

SQL template when both system and code are provided.

token-sql.only-system

0..1

string

SQL template when only system is provided.

token-sql.only-code

0..1

string

SQL template when only code is provided.

token-sql.text-format

0..1

string

Format for text search.

token-sql.no-system

0..1

string

SQL template when no system is provided.

where

0..1

string

SQL to use in the WHERE expression. Supports `{{table}}` and `{{param}}`.

SearchQuery

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

as

0..1

string

Alias for the resource in the query.

includes

0..1

Object

Resources to include with the results.

limit

0..1

integer

Maximum number of results to return.

params

0..1

Object

Search parameters for the query.

query

0..1

BackboneElement

Detailed query configuration.

query.order-by

0..1

string

Column or expression to order results by.

query.join

0..1

Object

Join conditions for the query.

query.where

0..1

string

Where clause for the query.

resource

1..1

Reference

Reference to the resource type to search.

total

0..1

boolean

Whether to include total count in results.

SeedImport

Path
Card.
Type
Description

filename

0..1

string

Name of the seed import file.

md5-hash

0..1

string

MD5 hash of the import file for integrity verification.

resources

0..*

Resources to be imported.

resources.resourceType

0..1

string

Type of resource.

resources.id

0..1

string

Identifier for the resource.

resources.meta

0..1

Object

Metadata for the resource.

version

0..1

string

Version of the seed import format.

Allowed values: v2

SubsNotification

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

duration

0..1

integer

Duration of the notification processing in milliseconds.

notification

0..1

Object

Content of the notification that was sent.

response

0..1

Object

Response received from the notification endpoint.

retried

0..1

boolean

Whether this notification is a retry.

retries

0..*

Reference

References to retry notifications.

Allowed references: SubsSubscription

retryOf

0..1

Reference

Reference to the original notification this is retrying.

Allowed references: SubsSubscription

status

0..1

code

Status of the notification delivery.

Allowed values: success | failed

subscription

0..1

Reference

Reference to the subscription that generated this notification.

Allowed references: SubsSubscription

SubsSubscription

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

channel

1..1

Channel configuration for delivering notifications.

channel.timeout

0..1

integer

Timeout in milliseconds for notification delivery.

channel.heartbeatPeriod

0..1

integer

Period in milliseconds for sending heartbeat notifications.

channel.headers

0..1

Object

HTTP headers to include with notifications.

channel.type

1..1

code

Type of channel for notifications.

Allowed values: rest-hook

channel.endpoint

1..1

url

URL endpoint where notifications are sent.

channel.payload

0..1

Content to be sent in the notification.

channel.payload.content

0..1

code

Allowed values: id-only | full-resource

channel.payload.contentType

0..1

code

Allowed values: json | fhir+json

channel.payload.context

0..1

identifier

0..*

Identifier

Business identifiers for the subscription.

status

0..1

code

Current status of the subscription.

Allowed values: active | off

trigger

0..1

Object

Events that trigger this subscription.

TerminologyBundleFile

Path
Card.
Type
Description

filename

0..1

string

Name of the terminology bundle file.

status

0..1

string

Current status of the bundle file processing.

Allowed values: pending | in-progress | fail | success

ui_history

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

command

0..1

string

Command that was executed.

type

0..1

string

Type of history entry.

Allowed values: http | sql

user

0..1

Reference

Reference to the user who performed the action.

Allowed references: User

ui_snippet

Path
Card.
Type
Description

_source

0..1

string

System Property. DO NOT USE IT.

command

0..1

string

title

0..1

string

type

0..1

string

Allowed values: http | sql

user

0..1

Reference

Allowed references: User

PreviousSDC Module ResourcesNextBulk Module Resources

Last updated 2 days ago

Was this helpful?